Order Changes API Routes

An order change is a proposed change to an order, such as adding or removing items, changing shipping methods, and more. They can be associated with order edits, claims, or exchanges. These API routes allow admin users to manage order changes.

POST /admin/order-changes/{id}#

Update an Order Change

Update an order change's details. An order change can be an exchange, claim, or edit. For example, you can edit whether an exchange carries over the parent order's promotion.

Authentication: secret API key (HTTP Basic authorization), cookie session, JWT bearer token.

Path parameters

idstring

The order change's ID.

Query parameters

created_atobjectOptional

Filter by the order change's creation date. Accepts the filter operators.

updated_atobjectOptional

Filter by the order change's update date. Accepts the filter operators.

deleted_atobjectOptional

Filter by the order change's deletion date. Accepts the filter operators.

idstring | string[] | objectOptional

Filter by an order change's ID.

statusstring | string[] | objectOptional

Filter by an order change's status.

change_typestring | string[] | objectOptional

Filter by the order change's change type.

$andobject[]Optional

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

$orobject[]Optional

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

fieldsstringOptional

Comma-separated fields that should be included in the returned data. If a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. Without prefix it will replace the entire default fields.

Request body (application/json)

carry_over_promotionsbooleanOptional

Whether promotions from the original order should be carried over to the order change (specifically, exchanges).

internal_notestringOptional

The order change's internal note.

Request examples

Responses

200 OK

order_changeobject

The order change's details.

400, 401, 404, 409, 422, 500: an error response is returned.

Found a problem with this page?Report Issue

Edited Nov 14·Edit this page