Order API V3 Upload API

1. API
2. v1
3. group_orders
4. upload
Check out List Item docs

Route

Responses

action-successful 200

This status indicates that the request was successful. If the request returns data, it can be found in the data key.

{"code": 200, "data": {}, "status": "action-successful", "message": "..."}

---

invalid-file-type 400

This response is returned when the file uploaded wasn't identified as a CSV or XLSX file type.

{"code": 400, "status": "invalid-file-type", "message": "..."}

---

file-too-large 400

This response is returned when the file uploaded wasn't identified as larger that 50kb.

{"code": 400, "status": "file-too-large", "message": "..."}

---

session-required 400

This response is returned when this API is called from a requester that isn't a session, e.g., and another application. This is an important validation because a group order must be tied to a user.

{"code": 400, "status": "session-required", "message": "..."}

---

multiple-sheets 400

This response is returned when the uploaded spreadsheet had more than one wrokersheet.

{"code": 400, "status": "multiple-sheets", "message": "...", "sheets_count": "..."}

---

empty-sheet 400

This response is returned when the uploaded spreadsheet is empty or has no order rows.

{"code": 400, "status": "empty-sheet", "message": "..."}

---

too-many-orders 400

This response is returned when the uploaded spreadsheet has more orders then is allowed with each upload. On September 22nd, 2023 this max is 200 orders but can be found in the system value `group_order_max_orders`

{"code": 400, "status": "too-many-orders", "message": "...", "max_orders": "...", "requested_orders": "..."}

---

missing-spreadsheet-headers 400

This response is returned when the uploaded spreadsheet is missing one of the required headers for a group order. The required headers can be found in the system value `group_order_required_headers`

{"code": 400, "status": "missing-spreadsheet-headers", "message": "...", "missing_headers": ["...", "..."]}

---

file-read-error 500

This response is returned when there was an issue reading the file passed.

{"code": 500, "status": "file-read-error", "message": "..."}

---

invalid-token 401

This status is returned when the authentication token passed is invalid.

{"code": 401, "status": "invalid-token", "message": "..."}

---

session-expired 401

This status is returned a session is older than seven days or hasn't been used in 72 hours. The user will need to reauthenticate. We allow our users to save a remember_me preference which will make there sessions last indefinitely.

{"code": 401, "status": "session-expired", "message": "..."}

---

client-required 401

This status is returned when the user makeing the request doesn't have a client, employee or liaison record. This means that they don't have any roles or permissions. Because we only allow our clients to register as a client, the user should be redirected to the PlanoAuth clients registration page where they can use the `/api/v1/users/client_register` API to register as a client. Eventhough the request will not be successful, this status will still return a `session` object because a session token is needed to register as a user.

{"code": 401, "status": "client-required", "message": "...", "session": {}}

---

missing-param 400

This status is returned when a required param was not passed with the request.

{"code": 400, "status": "missing-param", "message": "...", "missing_param": "email"}

---

invalid-param 400

This status is returned when a param was invalid when passed. For example, passing an id that doesn't exist or passing an invalid email address.

{"code": 400, "status": "invalid-param", "message": "...", "invalid_param": "email"}

---

application-crash 500

This status is returned when there is an internal server error. Please try again later.

{"code": 500, "errors": "...", "status": "application-crash", "message": "..."}

---

mandrill-email-failed 500

This status is returned when there was an issue using Mandrill to send an email. Any time this response is returned, there will be a notification in the production notifications tab so the dev team will be away of the failure. These errors will most likely correlate with a data issue and will need to be invesigated.

{"code": 500, "errors": "...", "status": "mandrill-email-failed", "message": "..."}

---

invalid-content-type 400

This status is returned if the request was made with the incorrect content-type so the request params could not be read. For more infromation on content-type, please refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type.

{"code": 400, "status": "invalid-content-type", "message": "...", "content_type_passed": "application/json", "content_type_required": "text/plain"}

---

route-non-existent 500

Response returned when HTTP route does not exist.

{"code": 500, "status": "route-non-existent", "message": "..."}

---

Uncommon Responses

The responses below are not very common.

no-params-decoded Uncommon

This status is returned the request body was decoded, but no params where found.

{"code": 400, "status": "no-params-decoded", "message": "..."}

---

invalid-encoded-params Uncommon

This status is returned when the request body could not be decoded properly. This generally means that you are requesting a sensative_params API and your request body was not base64 encoded.

{"code": 400, "errors": "...", "status": "invalid-encoded-params"}

---

route-not-found Uncommon

This status is returned when the route record being requested hasn't been deployed yet.

{"code": 404, "path": "...", "status": "route-not-found", "message": "...", "http_method": "..."}

---

identify-request-error Uncommon

This status is returned when there is an internal server error before the route could be identified. Please try again later.

{"code": 500, "errors": "...", "status": "identify-request-error", "message": "..."}

---

service-not-found Uncommon

This status is returned when the route's API service record being requested hasn't been deployed yet.

{"code": 404, "status": "service-not-found", "message": "...", "route_id": "...", "api_service_key": "..."}

---