Skip to main content

Order

workspace
REQUIRED

Type: string (format: iri-reference)

The workspace reference to which the order belongs.

Example: /workspaces/cbe5589f-8869-4a9c-9d9c-3d7f70d66878

orderNumber
REQUIRED

Type: string|null

A number associated with a purchase order.

Example: ON1

externalSourceIntegration

Type: string|null (format: iri-reference)

The workflow reference to integration for ecommerce store.

Example: /workflows/a0b97939-5aea-4b35-b7c6-64f56bff1721

externalSourceSyncId

Type: string|null

The id of the order in ecommerce store (WooCommerce, Shopify, etc.).

Example: wo_1001

externalSourceUrl

Type: string|null (format: URL)

The url of the order in ecommerce store.

Example: http://my-store.com/admin/orders/wo_1001

subtotal

Type: string|null

The current subtotal price of the order in the store currency. Default value is 0

Example: 199.9

total

Type: string|null

The current total price of the order in the store currency. Default value is 0

Example: 199.9

currency

Type: string|null

A three-letter currency code. Default value is USD

Example: EUR

orderStatus

Type: object|null

The current status of order. Represented by the Status object.

Example: 
"orderStatus": {
  "code": "new",
  "title": "New",
  "id": "c2dc66dc-9b21-4144-8b1f-4e1e1bb866d6"
}
  • code:

    A unique status code. This field is required.

  • title:

    A status name. This field is optional.

  • id:

    A version 4 UUID.

orderType
REQUIRED

Type: string

customer|vendor

Example: customer

email

Type: string|null (format: email)

Customer email address.

Example: non-existing@trackmage.com

phoneNumber

Type: string|null

Customer phone number.

Example: 13125551212

createdAt

Type: string (format: date-time)

The date and time (in ISO-8601 format) when the order was created.

Example: 1610236800

updatedAt

Type: string (format: date-time)

The date and time (in ISO-8601 format) when the order was updated.

Example: 1610236800

shipments

Type: array

List of shipment references that belong to the order.

Example: ["/shipments/cbe5589f-8869-4a9c-9d9c-3d7f70d66878"]

shippingAddress

Type: object|null

The mailing address to where the order will be shipped. Represented by the Address object.

Example: 
"shippingAddress": {
  "addressLine1": "567 East Cedar",
  "addressLine2": "Apartment 1",
  "city": "Liberal",
  "company": "Acme, Inc.",
  "country": "United States",
  "countryIso2": "US",
  "firstName": "Dorothy",
  "lastName": "Gale",
  "postcode": 67901,
  "state": "Kansas"
}
  • addressLine1:

    The street address. This field is optional.

  • addressLine2:

    An optional additional field for the street address. This field is optional.

  • city:

    The city, town, or village. This field is optional.

  • company:

    The company of the person associated with the address. This field is optional.

  • country:

    The name of the country. This field is optional.

  • countryIso2:

    The two-letter country code. This field is optional.

  • firstName:

    The first name of the person associated with the address. This field is optional.

  • lastName:

    The last name of the person associated with the address. This field is optional.

  • postcode:

    The postal code (zip, postcode, Eircode, …). This field is optional.

  • state:

    The name of the region (province, state, prefecture, …). This field is optional.

billingAddress

Type: object|null

The mailing address associated with the payment method. Represented by the Address object.

Example: 
"billingAddress": {
  "addressLine1": "567 East Cedar",
  "addressLine2": "Apartment 1",
  "city": "Liberal",
  "company": "Acme, Inc.",
  "country": "United States",
  "countryIso2": "US",
  "firstName": "Dorothy",
  "lastName": "Gale",
  "postcode": 67901,
  "state": "Kansas"
}
  • addressLine1:

    The street address. This field is optional.

  • addressLine2:

    An optional additional field for the street address. This field is optional.

  • city:

    The city, town, or village. This field is optional.

  • company:

    The company of the person associated with the address. This field is optional.

  • country:

    The name of the country. This field is optional.

  • countryIso2:

    The two-letter country code. This field is optional.

  • firstName:

    The first name of the person associated with the address. This field is optional.

  • lastName:

    The last name of the person associated with the address. This field is optional.

  • postcode:

    The postal code (zip, postcode, Eircode, …). This field is optional.

  • state:

    The name of the region (province, state, prefecture, …). This field is optional.

fulfillmentStatus

Type: string|null

The fulfillment status code. The calculation is based on qty and fulfilledQty properties of children order items.

  • not_fulfilled - order does not contain any shipped order items
  • partial - order contains at least one shipped order item, and at least one not shipped order item
  • fulfilled - all order items of the order are shipped

Example: partial

shipmentsWithoutTrackingCount

Type: integer|null

id
READ-ONLY

Type: string (format: uuid)

A version 4 UUID. A unique order identifier is used in API requests.

Example: d20215c9-0691-4783-a2f0-fb56938e5a78

readonly
READ-ONLY

Type: boolean