post

/v1/store/{storeId}/order/ship

Ship an Order

This operation aims at letting the marketplace know that you have shipped the order. You can add relevant shipping information to your order, such as: carrier, tracking link, and tracking number. Once this operation is completed, the order will switch to a Shipped status.

Please note that this is an asynchronous operation, meaning that you won’t see the result of your action right away. This operation will create a ticket, which you can access via a specific endpoint, as to check on the progress of your operation (see the List Tickets and View a Ticket endpoints).

Authorization

apiKey - Authorization

Request Parameters

1 Path Parameter

Request Body

Schema
object
order
array[object]

Responses

1 Header
Schema
object

When a request is executed asynchronously a link to ticket will be provided to follow execution process.

id
string

The ticket ID

1 validation + required
_links
object
required

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
storeId
$$.env
1 variable not set
Authorization