This API lets you update the fields, comment, shippingProvider,
and/or shippingTracking for a given order. All three fields can be
updated simultaneously or independently.
Required scope | ecommerce:write
Unique identifier for a Site
Unique identifier for an Order
Arbitrary data for your records
Company or method used to ship order
Tracking number for order shipment
URL to track order shipment
Request was successful
The order ID. Will usually be 6 hex characters, but can also be 9 hex characters if the site has a very large number of Orders. Randomly assigned.
The status of the Order
A comment string for this Order, which is editable by API user (not used by Webflow).
A comment that the customer left when making their Order
The ISO8601 timestamp that an Order was placed.
When an Order is marked as ‘fulfilled’, this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.
When an Order is marked as ‘refunded’, this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.
When an Order is marked as ‘disputed’, this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.
If an Order has been disputed by the customer, this key will be set to the ISO8601 timestamp of the last update received. If the Order is not disputed, the key will be null.
If an order was disputed by the customer, then this key will be set with the dispute’s status.
The total paid by the customer
The net amount after application fees
The application fee assessed by the platform
All addresses provided by the customer during the ordering flow.
The shipping address
The billing address
A string editable by the API user to note the shipping provider used (not used by Webflow).
A string editable by the API user to note the shipping tracking number for the order (not used by Webflow).
An object with the keys fullName and email.
An array of all things that the Customer purchased.
The sum of all ‘count’ fields in ‘purchasedItems’.
An object with various Stripe IDs, useful for linking into the stripe dashboard.
Details on the card used to fulfill this order, if this order was finalized with Stripe.
An array of additional inputs for custom order data gathering. Each object in the array represents an input with a name, and a textInput, textArea, or checkbox value.
A boolean indicating whether the customer has been deleted from the site.
A boolean indicating whether the order contains one or more purchased items that require shipping.
A boolean indicating whether the order contains one or more purchased items that are downloadable.
A string indicating the payment processor used for this order.
An object describing various pricing totals
An array of downloadable file objects.