Skip to main content
POST
Add shipment to order

Request

Headers

Body parameters

Successful response

Error responses

404 Order not found

400 Missing required field

Authorizations

Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Body

application/json
orderId
string
required

The order ID to associate with the shipment.

shippingAddressId
string
required

The shipping address ID to use for delivery.

shippingOptionId
string
required

The shipping option/carrier to use.

Response

Shipment added to order successfully.

status
integer
required
success
boolean
required
message
string
required
data
object
required