PATCH /sites/{site_id}/orders/{order_id}

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

Servers

Path parameters

Name Type Required Description
site_id String Yes

Unique identifier for a Site

order_id String Yes

Unique identifier for an Order

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
comment String No

Arbitrary data for your records

shippingTrackingURL String No

URL to track order shipment

shippingProvider String No

Company or method used to ship order

shippingTracking String No

Tracking number for order shipment

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.