Add Shipping Method to Draft Order Edit
Add a shipping method to a draft order edit.
In: header
Path Parameters
The draft order's ID.
Request Body
application/json
The ID of the shipping option that this method is created from.
A custom amount to be charged for this shipping method. If not provided, the shipping option's amount will be used.
The shipping method's description.
A note viewed only by admin users about the shipping method.
The shipping method's metadata, can hold custom key-value pairs.
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" \ -H "Content-Type: application/json" \ -d '{ "shipping_option_id": "string" }'{
"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"
}Request Edit on Draft Order
Change the status of a draft order's edit to be requested. Later, the edit can be confirmed or canceled.
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.