Order Stages Create API

Route

POST

Purpose

RESTful API for inserting new rows into order_statuses and order_stages table(s).

Parameters

order_id integer 1

Olio order ID. Required if order_request_id not provided.

order_request_id integer 2

Order Request ID. Required if order_id not provided.

update_status boolean 3 required

Boolean that indicates if the order status record should be updated or not.

stage string 4 required

The stage of the order.

stage_trigger string 5

The stage_trigger of the order.

stage_at_mt string 6

The stage_start_at value timestamp.

created_at_mt string 7

The created_at_fm value timestamp.

created_by_id integer 8

The user that created these records. If provided, populates the created_by with user's first and last name.

created_by string 9

If provided, parameter will override created_by_id logic.

appointment hash 10

Appointment Information.

Show child params

appointment.appt_id integer
appointment.appt_confirmed string
appointment.appt_duration_time string
appointment.appt_start_at string
appointment.appt_stop_at string
appointment.cancel_reason string
appointment.cancel_note string

client hash 11

Sets the client_id and related attributes in order_statuses if provided. Otherwise, additional client data is queried in DB.

Show child params

client.client_id integer
client.client_billing_postal_code integer

order hash 12

Sets the order details, if provided.

Show child params

order.notes string
order.delivery_rush boolean
order.due_date string
order.external_id string
order.service_type string
order.services_addon_array array
order.cancel_reason string
order.cancel_note string

notes string 13

updated_by string 14

updated_by_id integer 15

notified_at_mt string 16

event_slug string 17

token string 100 required

Authentication token for either an application or session.

application_view string 110

View of application object you would like returned.

application string 200

Slug of application being requested. This is used to determine the role being used to make the request and therefore evaluate if the requester has the correct permissions.

Possible values

planoauth
planoorder
planox2

session_view string 300

View of session object you would like returned.

Request Body Example: application/json

          {"order_id": 33534, "order_request_id": 99764, "update_status": true, "stage": "Completed", "stage_trigger": "Submitted", "stage_at_mt": "2019-08-28 14:29:19", "created_at_mt": "2019-08-28 14:29:19", "created_by_id": 10, "created_by": "Tyrone Biggums", "appointment": {"appt_id": 1, "appt_confirmed": "No", "appt_duration_time": "00:30:00", "appt_start_at": "2020-08-26 10:00:00", "appt_stop_at": "2020-08-26 10:30:00", "cancel_reason": "Foul Smell", "cancel_note": "Mold growing in walls."}, "client": {"client_id": 14, "client_billing_postal_code": 80918}, "order": {"notes": "Order Notes", "delivery_rush": true, "due_date": "2020-08-25", "external_id": "a0w3o000015uRmhAAE", "service_type": "Primary", "services_addon_array": ["RUSH Weekend Free", "Virtual Twilight Add On"], "cancel_reason": "On-Sight Contact Cancelled", "cancel_note": "Could not enter the property."}, "notes": "These are example notes.", "updated_by": "Babooshka Bob", "updated_by_id": 41, "notified_at_mt": "2019-08-28 14:29:19", "event_slug": "pending_appointment", "token": "Sw543vdfgswWg98", "application_view": null, "application": "planoauth", "session_view": null}

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": {"order_stage": {"id": 47832, "olio_id": 325780, "stage": "ordered", "stage_trigger": "Ordered", "notes": "requested Orderedr", "order_request_id": 126788, "appt_id": null, "stage_start_at": "2019-08-21T115140.000Z", "stage_end_at": "2019-08-21T151634.000Z", "created_by": "inflow", "created_by_id": 0, "updated_by": "order_create_aux[] nepal.planomatic.com", "updated_by_id": null, "created_at_fm": "2019-08-21T115142.000Z", "updated_at_fm": "2019-09-23T111800.000Z", "created_at": "2019-08-21T175142.000Z", "updated_at": "2019-09-23T171800.000Z", "updated_in": "9/23/2019 1118 AM olio dev_populate_stages_created_by dev", "cancel_reason": null, "cancel_note": null, "appt_cancel_reason": null, "appt_cancel_note": null, "event_slug": null}, "order_status": {"id": 82987, "_id": "8212926e-be96-4d18-823c-1a29dd30870e", "olio_id": 325780, "client_id": 33359, "company_id": 226, "due_date": "2019-08-28", "delivery_rush": null, "service_type": "Pro Photo Package + Floor Plan", "services_addon_array": null, "order_created_at": "2019-08-21T113011.000Z", "appt_confirmed": "no", "appt_start_at": "2019-08-26T090000.000Z", "appt_stop_at": "2019-08-26T150000.000Z", "appt_duration_time": "2000-01-01T060000.000Z", "status": "cancelled", "notes": null, "cancel_reason": null, "external_id": null, "order_request_id": 126788, "order_request_created_at": "2019-08-21T112151.000Z", "client_first_name": "Daria", "client_last_name": "Kamford", "client_email": "dkamford@houlihanlawrence.com", "client_phone": "203-554-0250", "client_billing_postal_code": "06820", "updated_in": "8/28/2019 100050 AM olio order_stage_update[] inflow", "created_at": "2019-08-21T175144.000Z", "created_at_mt": "2019-08-21T115144.000Z", "updated_at": "2019-08-28T160050.000Z", "updated_at_mt": "2019-08-28T100050.000Z", "notified_at": null, "notified_at_mt": null, "cancel_note": null, "appt_cancel_reason": null, "appt_cancel_note": null, "event_slug": null}, "previous_order_stage": {"id": 60307, "olio_id": 325780, "stage": "cancelled", "stage_trigger": "Canceled", "notes": "requested CanceledrRequested Canceledr", "order_request_id": 126788, "appt_id": null, "stage_start_at": "2019-08-28T100045.000Z", "stage_end_at": null, "created_by": "inflow", "created_by_id": 0, "updated_by": "changed_items_process_loop fms.planomatic.com", "updated_by_id": null, "created_at_fm": "2019-08-28T100048.000Z", "updated_at_fm": "2019-09-23T200901.000Z", "created_at": "2019-08-28T160048.000Z", "updated_at": "2019-09-24T020901.000Z", "updated_in": "9/23/2019 80901 PM olio dev_populate_stages_created_by dev", "cancel_reason": null, "cancel_note": null, "appt_cancel_reason": null, "appt_cancel_note": null, "event_slug": null}}, "status": "action-successful", "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": "..."}