order

Get an order by pk or uuid

get/api/order/order/{id}/

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

idstring required

Order pk or uuid. A uuid addresses the order the emailed link carries; the answer is the full detail either way.

Headers

Authorizationstring

Authorization token

Response

idinteger required
uuidstring uuid
customer_idstring nullable
order_idstring
customer_referencestring nullable
order_referencestring nullable
order_typestring nullable
customer_remarksstring nullable
descriptionstring nullable
start_datestring required

Display string in the tenant's configured date_format, not an ISO-8601 value.

start_timestring nullable

Display string in the tenant's configured date_format, not an ISO-8601 value.

end_datestring required

Display string in the tenant's configured date_format, not an ISO-8601 value.

end_timestring nullable

Display string in the tenant's configured date_format, not an ISO-8601 value.

order_datestring required
remarksstring nullable
order_namestring required
order_addressstring nullable
order_postalstring nullable
order_citystring nullable
order_country_codestring nullable
order_telstring nullable
order_mobilestring nullable
order_emailstring nullable
order_contactstring nullable
createdstring required

Display string in the tenant's configured date_format, not an ISO-8601 value.

modifiedstring required

Display string in the tenant's configured date_format, not an ISO-8601 value.

workorder_pdf_urlstring nullable required
total_price_purchasestring decimal
total_price_sellingstring decimal
customer_relationinteger nullable
required_assignedstring required
required_usersinteger
user_order_available_set_countinteger required
assigned_countinteger required
workorder_urlstring required
customer_order_acceptedboolean
branchinteger nullable
external_identifierstring nullable
quotationinteger nullable
planning_remarksstring nullable
last_updatestring date-time required
order_email_extrastring[]
start_date_isostring date required
end_date_isostring date required
last_statusstring required
last_status_fullstring nullable required
last_status_datestring date-time nullable required
statuscode_idinteger nullable required
colorstring nullable required
text_colorstring nullable required

Changes

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      for the path request parameter id, the type was generalized from integer to string