Commerce Orders

The Orders object

From the Orders endpoint, you can retrieve a list of all orders for a specified business.

FieldTypeDescription
id
filterable
string Identifier of the order
orderNumber
filterable
stringFriendly reference for the order in the commerce or point of sale platform.
status
sortable, filterable
stringstatus of the order.
paymentStatus
sortable, filterable
stringStatus of the payment.
fulfillmentStatus
sortable, filterable
stringCurrent status of the fulfillment for the order.
fulfillmentRefsReference TypesFulfillment of the order.
lines arrayAn array of order lines
refundRefs Reference TypesRefund of the order.
transactionSourceRefsReference TypesTransaction Source of the order.
billingAddressReference TypesBilling address of the order.
shippingAddressReference TypesShipping address of the order.
customerRefReference TypesCustomer of the order.
totalShippingAmount
filterable
decimalThe sum of all the shipping costs for the order.
totalGratuityAmount
filterable
decimalThe sum of all the discounts applied to the total price before tax.
totalTaxAmount
filterable
decimalThe sum of all the taxes applied to the order.
totalAmount
filterable
decimalThe sum of all the line items prices, shipping, taxes and tips/gratuities and minus discounts.
currencyRefReference TypesCurrency of the order.
createdDate
sortable, filterable
string
See Date
Date the order was created in the commerce platform.
sourceModifiedDate
sortable, filterable
string
See Date
Date the order was last updated in the commerce platform.

Lines

FieldTypeDescription
idstringIdentifier of the Line Item.
productId filterablestringID of the product represented in the Line Item. If the product has been deleted or does not exist, the value will be null.
variantId filterablestringID of the product variant represented in the Line Item. If the variant has been deleted or does not exist, the value will be null.
name filterablestringName text of the line item. This should be the same as the name of the variant from the products endpoint.
quantity filterableintegerThe number of variants sold for this line item.
totalPrice filterabledecimalTotal cost of all of the products associated with this line item added together. Typically it would be unitPrice times quantity plus other fees, if any.
unitPrice filterabledecimalPrice per unit of the variant associated with the line item.
skustringThe stock keeping unit of the variant associated with this line item.

Fulfillment Order Status

  • fulfilled - Means every line item in the order has been fulfilled.
  • partial - Means the order is partially fulfilled.
  • unfulfilled - Means none of the line items in the order have been fulfilled.
  • cancelled - Means that the order has been cancelled.
  • unknown - Railz is unable to identify the fulfillment order status.