The sales order object

AttributeDescription
idUnique identifier for the object.
customer_idID of the customer who this order belongs to.
order_noA unique, identifying string used in the UI and controlled by the user.
sourceIndication of whether the sales order was created manually, by API or imported from somewhere else.
order_created_dateThe timestamp of creating the document. ISO 8601 format with time and timezone must be used.
delivery_dateA timestamp when the items are required to be delivered to the customer. ISO 8601 format with time and timezone must be used.
picked_dateThe timestamp when the Sales Order Delivery status was initially marked as "PACKED" or "DELIVERED". ISO 8601 format with time and timezone must be used. If multiple fulfillments exist for a sales order, the latest picked_date is used.
location_idID of the location from which the order is shipped.
statusStatus of the order. Possible values are “NOT_SHIPPED”, "PARTIALLY_PACKED", "PARTIALLY_DELIVERED", “PACKED” and “DELIVERED”.
currencyCurrency of the sales order. Filled with customer currency by default.
conversion_rateCurrency rate used to convert from sales order currency into factory base currency. If multiple fulfillments exist for a sales order row, the latest date and corresponding rate are used.
conversion_dateThe date of the conversion rate used. If multiple fulfillments exist for a sales order row, the latest date is used.
invoicing_statusIndicating the status of generating the invoice through accounting integration to either Xero or QuickBooks Online.
totalThe total value of the order (including taxes) in sales order currency.
total_in_base_currencyThe total value of the order (including taxes) in base currency.
additional_infoA string attached to the object to add any internal comments, links to external files, additional instructions, etc.
customer_refAn identifier to reference the customer associated with the sales order
sales_order_rowsAn array of sales order rows.
ecommerce_order_typeName of the ecommerce platform in case the order is imported from one.
ecommerce_store_nameName of the ecommerce store in case the order is imported from an ecommerce platform.
ecommerce_order_idID of the order in the source system in case it is imported from an ecommerce platform.
product_availabilityStock status for the products required by the sales order. Possible values are "IN_STOCK", "EXPECTED", "PICKED", "NOT_AVAILABLE", "NOT_APPLICABLE".
product_expected_dateThe latest date of a manufacturing order production deadline or a purchasing order expected arrival date that relates to the required products.
ingredient_availabilityStock status for ingredients required to produce the products on the sales order. Possible values are "PROCESSED", "IN_STOCK", "NOT_AVAILABLE", "EXPECTED", "NO_RECIPE", "NOT_APPLICABLE".
ingredient_expected_dateThe latest date of a manufacturing order production deadline or a purchasing order expected arrival date that relates to the required ingredients to produce the products.
production_statusProduction status of the manufacturing order that is making products for the respective sales order. Possible values are "NOT_STARTED", "NONE", "NOT_APPLICABLE", "IN_PROGRESS", "BLOCKED", "DONE".
created_atThe timestamp when the sales order was created.
updated_atThe timestamp when the sales order was last updated.
tracking_numberThe shipment tracking number received from the carrier.
tracking_number_urlThe link to online tracking data about the shipment.
billing_address_idThe ID of the billing address of the sales order.
shipping_address_idThe ID of the shipping address of the sales order.
addressesAn array of shipping and billing addresses.

The sales order row object

AttributeDescription
idUnique identifier for the object.
quantityThe quantity of items for the order line.
variant_idID of product variant added to the order line.
tax_rate_idID of tax added to price per unit.
price_per_unitThe sales price of one unit (excluding taxes) in sales order currency.
price_per_unit_in_base_currencyThe sales price of one unit (excluding taxes) in base currency.
totalThe total value of the sales order row (excluding taxes) in sales order currency.
total_in_base_currencyThe total value of the order (excluding taxes) in base currency.
attributesAn array of sales order row attributes. Each attribute is a key-value pair. Used to add extra details to the sales order row.
attributes.keyCustom key for the sales order row attribute.
attributes.valueCustom value for the key in sales order row attribute.
batch_transactionsAn array of batch transactions and their quantities. You can fulfill the item on the order from multiple batches.
batch_transaction.batch_idID of the batch for the fulfilled item.
batch_transactions.quantityThe quantity fulfilled from a particular batch.
serial_numbersAn array of serial number IDs
linked_manufacturing_order_idThe ID of the manufacturing order if there is a make-to-order (MTO) manufacturing order related to the sales order row.
conversion_rateCurrency rate used to convert from sales order currency into factory base currency. If multiple fulfillments exist for a sales order row, the latest date and corresponding rate are used.
conversion_dateThe date of the conversion rate used. If multiple fulfillments exist for a sales order row, the latest date is used.
created_atThe timestamp when the sales order row was created.
updated_atThe timestamp when the sales order row was last updated.

The sales order address object

AttributeDescription
idUnique identifier for the sales order address object.
sales_order_idThe ID of the sales order related to the address.
entity_typeEither "billing" or "shipping" depending on the address type.
first_nameThe first name of the person related to the address.
last_nameThe last name of the person related to the address.
companyThe company name related to the address.
phoneThe phone number related to the address.
line_1The first line of the address (street name and house number).
line_2The second line of the address (apartment, suite, unit, or building).
cityThe city of the address.
stateThe state of the address.
zipThe zip code of the address.
countryThe country of the address.
created_atThe timestamp when the address was created.
updated_atThe timestamp when the address was updated.