Orders Object

Properties
idstringRead-onlyformat GUID

Order ID (auto-generated upon order creation).


numberintegerRead-only

Order number displayed in the owner's store (auto-generated).


dateCreatedstringRead-onlyformat date-time

Order creation date and time.


buyerInfoobject

Buyer information.


currencystringformat CURRENCY

Currency used for the pricing of this order in ISO-4217 format.


weightUnitstring
3 enum supported values:
UNSPECIFIED_WEIGHT_UNITKGLB

Weight unit used in this store.


totalsobject

Totals for order's line items.


billingInfoobject

Billing information.


shippingInfoobject

Shipping information.


buyerNotestringmaxLength 1000

A note added by the buyer.


readbooleanRead-onlydeprecated

Deprecated.


archivedbooleanRead-only

Whether or not the order was archived.


paymentStatusstring
7 enum supported values:
UNSPECIFIED_PAYMENT_STATUSPENDINGNOT_PAIDPAIDPARTIALLY_REFUNDEDFULLY_REFUNDEDPARTIALLY_PAID

Current status of the payment.


fulfillmentStatusstringRead-only
4 enum supported values:
NOT_FULFILLEDFULFILLEDCANCELEDPARTIALLY_FULFILLED

Order's current fulfillment status (whether the order received a tracking number or was delivered/picked up).


lineItemsArray <LineItem>minItems 1maxItems 300

Line items ordered.


activitiesArray <Activity>Read-only

Log of updates related to the order.


invoiceInfoobject

Invoice information.


fulfillmentsArray <Fulfillment>Read-only

Order fulfillment information.


discountobject

Discount information.


customFieldobject

Custom field information.


cartIdstringformat GUID

Shopping cart ID.


buyerLanguagestringmaxLength 10

Language for communication with the buyer. Defaults to the site language. For a site that supports multiple languages, this is the language the buyer selected.


channelInfoobject

Information about the sales channel that submitted this order.


enteredByobjectRead-only

Identity of the order's initiator.


lastUpdatedstringRead-onlyformat date-time

Date and time of latest update.


subscriptionInfoobject

Subscription information.


numericIdnumberRead-only

Order’s unique numeric ID. Primarily used for sorting and filtering when crawling all orders.


refundsArray <Refund>Read-only

Refund information.

Was this helpful?
Yes
No