NameDescriptionTypeAdditional information
order_status

order_status

None.
order_number

Order number.

 string

None.
location

string

None.
order_stage

Order stage. Possible values are:

  • 2 (Order Cancelled)
  • 4 (AV Required)
  • 5 (DPS Required)
  • 6 (Ship Method Rev)
  • 10 (Order Received)
  • 20 (Pick List Printed)
  • 30 (Partially Verified)
  • 40 (Fully Verified)
  • 50 (Partially Shipped)
  • 52 (Partially Shipped/Partially Verified)
  • 55 (Partially Shipped/Fully Verified)
  • 60 (Fully Shipped)
  • 62 (Closed Short)
  • 70 (Sub Order Shipped)

 integer

None.
stage_description

Order stage description (see 'order_stage').

 string

None.
is_cancelled

boolean

None.
is_back_order

'true' when one of the lines is in back order.

 boolean

None.
account_number

Account number of ownership.

 string

None.
order_type

Order Type defines how the order entered in DCL system (through Web Service, OrderPoints, etc.)

 string

None.
system_id

string

None.
ordered_date

Ordered date. Date in ISO-8601 format (YYYY-MM-DD).

 date

None.
received_date

Received date. Date in ISO-8601 format (YYYY-MM-DD) [when extended_date is true, format will be (YYYY-MM-DDTHH:MM:SS)].

 date

None.
po_number

Purchase Order Number.

 string

None.
customer_number

string

None.
freight_account

Freight account billed.

 string

None.
consignee_number

Third party account number when freight is billed to a third party account.

 string

None.
shipping_carrier

Original shipping carrier name.

 string

None.
shipping_service

Original shipping service name.

 string

None.
shipping_address

address

None.
billing_address

address

None.
international_code

integer

None.
order_subtotal

decimal number

None.
shipping_handling

decimal number

None.
sales_tax

decimal number

None.
international_handling

decimal number

None.
total_due

decimal number

None.
amount_paid

decimal number

None.
net_due_currency

decimal number

None.
balance_due_us

decimal number

None.
international_declared_value

decimal number

None.
payment_type

string

None.
terms

string

None.
fob

string

None.
packing_list_type

integer

None.
packing_list_comments

string

None.
shipping_instructions

string

None.
custom_field1

string

None.
custom_field2

string

None.
custom_field3

string

None.
custom_field4

string

None.
custom_field5

string

None.
order_lines

List of lines included in the order.

 Collection of line

None.
shipments

List of all shipments related to the order.

 Collection of shipment

None.
modified_at

Modified date/time. Date in ISO-8601 format.

 string

None.