xclade
Admin APIOrder edits

Cancel Order Edit

Cancel a requested order edit.

DELETE
/admin/order-edits/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

The order edit's ID.

Response Body

application/json

application/json

text/plain

application/json

application/json

application/json

application/json

curl -X DELETE "https://{tenant}.api.myxclade.com/admin/order-edits/string"
{
  "id": "string",
  "object": "order-edit",
  "deleted": true
}

{
  "message": "Discount must be set to dynamic",
  "type": "not_allowed"
}

"Unauthorized"
{
  "message": "Entity with id 1 was not found",
  "type": "not_found"
}
{
  "code": "unknown_error",
  "message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
  "type": "QueryRunnerAlreadyReleasedError"
}
{
  "code": "invalid_request_error",
  "message": "Discount with code TEST already exists.",
  "type": "duplicate_error"
}

{
  "code": "api_error",
  "message": "An error occured while hashing password",
  "type": "database_error"
}

Update Existing Shipping Method in Draft Order Edit

Update an existing shipping method in a draft order edit.

Remove Item from Order Edit

Remove an added item in the order edit by the ID of the item's `ITEM_ADD` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.