The Orders object
Beta API Versions
API versions labelled as Beta are not subject to our standard versioning policy. As such, they may undergo small breaking changes until they are transitioned to the stable version. We encourage you to exercise caution when using Beta API versions and take the necessary steps to ensure a smooth integration into your applications
From the Orders endpoint, you can retrieve a list of all orders for a specified business.
| Field | Type | Description |
|---|---|---|
| id filterable | string | Identifier of the order |
| orderNumber filterable | string | Friendly reference for the order in the commerce or point of sale platform. |
| status sortable, filterable | string | status of the order. |
| paymentStatus sortable, filterable | string | Status of the payment. |
| fulfillmentStatus sortable, filterable | string | Current status of the fulfillment for the order. |
| fulfillmentRefs | Reference Types | Fulfillment of the order. |
| lines | array | An array of order lines |
| refundRefs | Reference Types | Refund of the order. |
| transactionSourceRefs | Reference Types | Transaction Source of the order. |
| billingAddress | Reference Types | Billing address of the order. |
| shippingAddress | Reference Types | Shipping address of the order. |
| customerRef | Reference Types | Customer of the order. |
| totalShippingAmount filterable | decimal | The sum of all the shipping costs for the order. |
| totalGratuityAmount filterable | decimal | The sum of all the discounts applied to the total price before tax. |
| totalTaxAmount filterable | decimal | The sum of all the taxes applied to the order. |
| totalAmount filterable | decimal | The sum of all the line items prices, shipping, taxes and tips/gratuities and minus discounts. |
| currencyRef | Reference Types | Currency 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
| Field | Type | Description |
|---|---|---|
| id | string | Identifier of the Line Item. |
| productId filterable | string | ID of the product represented in the Line Item. If the product has been deleted or does not exist, the value will be null. |
| variantId filterable | string | ID 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 filterable | string | Name text of the line item. This should be the same as the name of the variant from the products endpoint. |
| quantity filterable | integer | The number of variants sold for this line item. |
| totalPrice filterable | decimal | Total 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 filterable | decimal | Price per unit of the variant associated with the line item. |
| sku | string | The 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.