patch

/reverse-shipments/{shipment_id}/reassign

This endpoint reassigns any unshipped reverse-shipments to a different carrier or can be used to simply retry any reverse-shipments that are in “error” state due to a failure on the carrier side.

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.

  • To retry the shipment, original carrier account object should be specified in request.
  • To reassign the shipment, target carrier account should be specified in the request.
  • If no carrier account object specified, the rules engine will trigger to find the best suitable one.
  • Otherwise, operation has no effect.

Authorization

apiKey - x-api-key
oauth2 - clientCredentials

Request Parameters

1 Path Parameter
3 Headers

Request Body

Schema
object

Should contain carrier account ID and/or carrier account name. Carrier ID takes precedence.

carrier_id
string
carrier_account_name
string

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