Update Order

PATCH

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.

Path parameters

site_idstringRequired

Unique identifier for a Site

order_idstringRequired

Unique identifier for an Order

Headers

Accept-VersionstringOptional

The API version

Request

This endpoint expects an object.
fieldsobjectOptional

Response

Request was successful

orderIdstringOptional

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.

statusenumOptional

One of pending, unfulfilled, fulfilled, disputed, dispute-lost, or refunded

commentstringOptional

A comment string for this order editable by API user (not used by Webflow).

orderCommentstringOptional

A comment that the customer left when making their order

acceptedOndatetimeOptional

The ISO8601 timestamp that an order was placed.

disputedOndatetimeOptional

If an order was disputed by the customer, then this key will be set with the ISO8601 timestamp that Stripe notifies Webflow. Null if not disputed.

disputeUpdatedOnstringOptional

If an order was disputed by the customer, then this key will be set with the ISO8601 timestamp of the last time that we got an update. Null if not disputed.

disputeLastStatusstringOptional

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

fulfilledOndatetimeOptional

If an order was marked as ‘fulfilled’, then this is the ISO8601 timestamp when that happened.

refundedOndatetimeOptional

If an order was refunded, this is the ISO8601 of when that happened.

customerPaidobjectOptional

The sum of all line items.

netAmountobjectOptional

The sum of all line items.

requiresShippingbooleanOptional

A boolean indicating whether the order contains one or more purchased items that require shipping.

shippingProviderstringOptional

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

shippingTrackingstringOptional

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

customerInfoobjectOptional

An object with the keys fullName and email.

allAddresseslist of objectsOptional

All addresses provided by the customer during the ordering flow.

shippingAddressobjectOptional

A customer address

billingAddressobjectOptional

A customer address

purchasedItemslist of objectsOptional

An array of all things that the customer purchased.

stripeDetailsobjectOptional

An object with various Stripe IDs, useful for linking into the stripe dashboard.

stripeCardobjectOptional

Details on the card used to fulfill this order, if this order was finalized with Stripe.

totalsobjectOptional

An object describing various pricing totals.

customDatalist of maps from strings to anyOptional

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.

downloadFileslist of objectsOptional

An array of downloadable file objects.

Fulfill Order
Built with