Skip to main content
POST
Create a replacement shipment

Authorizations

Authorization
string
header
required

Access token

Path Parameters

reference_number
string
required

Reference number of the original shipment being replaced.

Required string length: 1 - 128
Pattern: ^(?:[A-Za-z0-9_-]{1,128}|MS:[A-Za-z0-9_-]{1,125})$

Body

application/json

Replacement shipment payload when fulfilling through a manual courier (no carrier integration).

warehouse_id
string
required

The warehouse from which the replacement items will be shipped.

Minimum string length: 1
shipping_option
enum<string>
required

Set to manual to dispatch the shipment outside of an integrated carrier.

Available options:
manual
shipping_provider_id
string
required

The manual shipping provider used to fulfill the replacement.

Minimum string length: 1
packing_option
enum<string>
required

The packing option for the replacement shipment.

Available options:
manual,
auto
expected_delivery_date
string<date> | null
required

The expected delivery date communicated to the customer.

Optional tracking URL shared with the customer.

manual_shipping_charges
number | null
required

Shipping charges incurred for the manual dispatch, with up to two decimal places.

Required range: x >= 0
reason
string
required

The reason for the replacement shipment.

Minimum string length: 1
fulfillment_type
string

Set to delivery when the replacement is shipped to the customer.

Allowed value: "delivery"
shipment_items
ReplacementShipmentItem · object[]

Omit to reuse the original shipment lines.

boxes
ShipmentBox · object[]

The boxes for the replacement shipment.

total_weight
number
required if packing_option = manual

Total shipment weight in kilograms, with up to three decimal places. Required and nonzero when packing_option is manual.

Response

OK

message
string
required
success
boolean
required