/shipments/draft/{shipment_id}
This endpoint updates draft shipment properties.
Authorization
Request Parameters
Request Body
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.
For the reverse-shipment payment_mode
and pending_amount
are not required and will be set to PRE_PAID
and 0
accordingly.
Merchant defined custom attributes in the form of a map:
{"attribute1" : ["value1", "value2"], "attribute2" : ["value1", "value2"]}
Responses
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.
For the reverse-shipment payment_mode
and pending_amount
are not required and will be set to PRE_PAID
and 0
accordingly.
Merchant defined custom attributes in the form of a map:
{"attribute1" : ["value1", "value2"], "attribute2" : ["value1", "value2"]}