This endpoint is intended to confirm a draft shipment. The result of this operation is similar to the result of creating a regular shipment: the latter goes to “pending” state and the asynchronous request is being sent to the corresponding carrier.

Authorization

apiKey - x-api-key

oauth2 - clientCredentials

Request Parameters

1 Path Parameter

3 Headers

Request Body

Schema

object

This payload is being used to perform operations on a shipment.

merchant

string

Merchant is mandatory for the most of Carriyo APIs. If it is not specified, the default merchant configured for a tenant will be used.

label

object

carrier_account

object

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

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.

required

delivery

object

required

collection

object

parcels

array[object]

items

array[object]

required

pickup

object

Pickup request must contain all the neccessary information about the sender: their name, phone number, email, address, city and country. These properties will be given from the corresponding partner location, if either of following fields are specified instead: partner_location_id, partner_location_name, partner_location_code.

required

dropoff

object

Dropoff request must contain all the neccessary information about the receiver: their name, phone number, email, address, city and country. These properties will be given from the corresponding partner location, if either of following fields are specified instead: partner_location_id, partner_location_name, partner_location_code.

required

custom_attributes

object

Merchant defined custom attributes in the form of a map:

{"attribute1" : ["value1", "value2"], "attribute2" : ["value1", "value2"]}

order_date

string

Must be a date in ISO 8601 format. Example: 2020-09-03T17:07:05.000Z

1 validation

language

string

Must be a two letter ISO 639-1 code. Example: en

1 validation

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