EcommerceOrders

Update Order

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

Path parameters

site_idstringRequiredformat: "objectid"
Unique identifier for a Site
order_idstringRequiredformat: "objectid"
Unique identifier for an Order

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

The order fields to update
commentstringOptional
Arbitrary data for your records
shippingProviderstringOptional
Company or method used to ship order
shippingTrackingstringOptional
Tracking number for order shipment
shippingTrackingURLstringOptional
URL to track order shipment

Response

Request was successful
orderIdstring or null
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.
statusenum or null
The status of the Order
commentstring or null

A comment string for this Order, which is editable by API user (not used by Webflow).

orderCommentstring or null
A comment that the customer left when making their Order
acceptedOnstring or nullformat: "date-time"
The ISO8601 timestamp that an Order was placed.
fulfilledOnstring or nullformat: "date-time"
When an Order is marked as 'fulfilled', this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.
refundedOnstring or nullformat: "date-time"
When an Order is marked as 'refunded', this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.
disputedOnstring or nullformat: "date-time"
When an Order is marked as 'disputed', this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.
disputeUpdatedOnstring or nullformat: "date-time"
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.
disputeLastStatusenum or null

If an order was disputed by the customer, then this key will be set with the dispute’s status.

customerPaidobject or null
The total paid by the customer
netAmountobject or null
The net amount after application fees
applicationFeeobject or null
The application fee assessed by the platform
allAddresseslist of objects or null
All addresses provided by the customer during the ordering flow.
shippingAddressobject or null
The shipping address
billingAddressobject or null
The billing address
shippingProviderstring or null

A string editable by the API user to note the shipping provider used (not used by Webflow).

shippingTrackingstring or null

A string editable by the API user to note the shipping tracking number for the order (not used by Webflow).

shippingTrackingURLstring or nullformat: "uri"
customerInfoobject or null

An object with the keys fullName and email.

purchasedItemslist of objects or null
An array of all things that the Customer purchased.
purchasedItemsCountdouble or null
The sum of all 'count' fields in 'purchasedItems'.
stripeDetailsobject or null
An object with various Stripe IDs, useful for linking into the stripe dashboard.
stripeCardobject or null
Details on the card used to fulfill this order, if this order was finalized with Stripe.
paypalDetailsobject or null
customDatalist of objects or null
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.
metadataobject or null
isCustomerDeletedboolean or null
A boolean indicating whether the customer has been deleted from the site.
isShippingRequiredboolean or null
A boolean indicating whether the order contains one or more purchased items that require shipping.
hasDownloadsboolean or null
A boolean indicating whether the order contains one or more purchased items that are downloadable.
paymentProcessorstring or null
A string indicating the payment processor used for this order.
totalsobject or null
An object describing various pricing totals
downloadFileslist of objects or null
An array of downloadable file objects.

Errors