PARTIALLY_REFUNDED - Order was refunded, but refund amount is less than order total price.
FULLY_REFUNDED - Order fully refunded. Refund amount equals total price.
PENDING - Payments received but not yet confirmed by the payment provider.
PARTIALLY_PAID - At least one payment was received and approved, covering less than total price amount.
fulfillmentStatusstringRead-only
3 enum supported values:
NOT_FULFILLEDFULFILLEDPARTIALLY_FULFILLED
Order fulfillment status.
buyerLanguagestring
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.
weightUnitstring
3 enum supported values:
UNSPECIFIED_WEIGHT_UNITKGLB
Weight measurement unit - defaults to site's weight unit.
currencystringformat CURRENCY
Currency used for the pricing of this order in ISO-4217 format.
taxIncludedInPricesboolean
Whether tax is included in line item prices.
siteLanguagestringRead-only
Site language in which original values are shown.
priceSummaryobjectRead-only
Order price summary.
billingInfoobject
Billing address and contact details.
shippingInfoobject
Shipping info and selected shipping option details.
INITIALIZED: Order created, but not yet approved or canceled.
APPROVED: Order approved. This happens when either an online payment is received or when order.priceSummary.total = 0 (a zero-total order). Offline orders (cash payment) are automatically approved.
CANCELED: Order canceled by the user.
archivedboolean
Whether order is archived.
taxSummaryobjectdeprecated - use taxInfo instead
Tax summary.
Deprecated. Use taxInfo instead.
This field will be removed on September 30, 2024.
taxInfoobject
Tax information.
appliedDiscountsArray <AppliedDiscount>
Applied discounts.
activitiesArray <Activity>Read-onlymaxItems 1000
Order activities.
attributionSourcestring
2 enum supported values:
UNSPECIFIEDFACEBOOK_ADS
Order attribution source.
createdByobjectRead-only
ID of the order's initiator.
channelInfoobject
Information about the sales channel that submitted this order.
seenByAHumanboolean
Whether a human has seen the order. Set when an order is clicked on in the dashboard.
checkoutIdstringformat GUID
Checkout ID.
customFieldsArray <CustomField>
Custom fields.
balanceSummaryobjectRead-only
Balance summary.
additionalFeesArray <AdditionalFee>maxItems 100
Additional fees applied to the order.
extendedFieldsobject
Custom field data for the order object.
Extended fields must be configured in the Wix Dev Center before they can be accessed with API calls.
purchaseFlowIdstringformat GUID
Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
recipientInfoobject
Order recipient address and contact details.
This field may differ from the address in shippingInfo.logistics when:
The chosen shipping option is pickup point or store pickup.