xclade
Admin APIDraft orders

Update Existing Shipping Method in Draft Order Edit

Update an existing shipping method in a draft order edit.

POST
/admin/draft-orders/{id}/edit/shipping-methods/method/{method_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

The draft order's ID.

method_id*string

The ID of the shipping method.

Request Body

application/json

shipping_option_id?string

The ID of the associated shipping option.

custom_amount?number

The custom amount of the shipping method. If not provided, the shipping option's amount will be used.

internal_note?string

A note viewed only by admin users about the shipping method.

Response Body

application/json

text/plain

application/json

application/json

application/json

application/json

curl -X POST "https://{tenant}.api.myxclade.com/admin/draft-orders/string/edit/shipping-methods/method/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty

{
  "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 New Shipping Method in Draft Order Edit

Update a new shipping method that was added to a draft order edit using the `ID` of the method's `SHIPPING_ADD` action. Every shipping method 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.

Cancel Order Edit

Cancel a requested order edit.