patch

/reverse-shipments/{shipment_id}/ready-to-ship

This endpoint sets the reverse-shipment as ready-to-ship for carriers supporting the operation. This is usually useful for on-demand carrier service where the carrier only picks up the shipment once notified.

The shipment_id is used as a path parameter to identify the reverse-shipment. Alternatively the client provided shipment reference (partner_shipment_reference) can also be used instead of the shipment_id.

Authorization

apiKey - x-api-key
oauth2 - clientCredentials

Request Parameters

1 Path Parameter
2 Headers

Request Body

Schema
object
parcels
string or array[object]

Responses

Schema
object
shipment_id
string
merchant
string
label
object
carrier_account
object
references
object
required
payment
object

For the reverse-shipment payment_mode and pending_amount are not required and will be set to PRE_PAID and 0 accordingly.

required
delivery
object
required
parcels
array[object]
items
array[object]
required
pickup
object
required
dropoff
object
required
post_shipping_info
object
required
custom_attributes
object
order_date
string
1 validation
creation_date
string
1 validation
update_date
string
1 validation
collection
object
rma_id
string

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
shipment_id
$$.env
2 variables not set
x-api-key
oauth_access_token