patch

/shipments/draft/{shipment_id}

This endpoint updates draft shipment properties.

Authorization

apiKey - x-api-key
oauth2 - clientCredentials

Request Parameters

1 Path Parameter
3 Headers

Request Body

Schema
object
merchant
string
label
object
carrier_account
object
references
object

Tenant provided references for a shipment. The partner_shipment_reference is not mandatory but is expected to be unique. If partner_shipment_reference is not passed, then the partner_order_reference is used as the partner_shipment_reference. The partner_shipment_reference is useful to provide a tenant defined reference for each shipment if a single order has multiple shipments.

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.

delivery
object
parcels
array[object]
items
array[object]
pickup
object
dropoff
object
custom_attriutes
object

Merchant defined custom attributes in the form of a map:

{"attribute1" : ["value1", "value2"], "attribute2" : ["value1", "value2"]}
order_date
string
1 validation

Responses

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

Tenant provided references for a shipment. The partner_shipment_reference is not mandatory but is expected to be unique. If partner_shipment_reference is not passed, then the partner_order_reference is used as the partner_shipment_reference. The partner_shipment_reference is useful to provide a tenant defined reference for each shipment if a single order has multiple shipments.

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.

delivery
object
parcels
array[object]
items
array[object]
pickup
object
dropoff
object
custom_attributes
object

Merchant defined custom attributes in the form of a map:

{"attribute1" : ["value1", "value2"], "attribute2" : ["value1", "value2"]}
order_date
string
1 validation
creation_date
string
1 validation
update_date
string
1 validation

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