Creating a Shipment

Overview

Endpoint: https://{base_url}/v1/shipments/
Method: POST
Headers:

Authorization: JWT {id_token}
Accept: application/json
Content-Type: application/json

Payload:

Check the example below

Response codes:

201: Created
400: Bad Request
401: Unauthorized

Grouping Shipments

Due to a trigger in the API, when it is necessary to group the submissions, the following rules must be observed

Grouping its allowed, only for same carrier.
If grouping shipments using multiple carriers, an error will occur, with the following message -
"Packages must use the same carrier."

Request

curl --location 'http://{base_url}/v1/shipments/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: JWT {id_token}' \
--data '{
    "seller": "dfb888d6-6a5d-4c0e-b7e3-546f0f74a3fb",
    "packages": ["10e0f9a3-7bb3-4f51-8b26-c65888e0a5b6", "0d569eb3-3574-40e9-818b-b3e62a0d1fc1"]
}'

Response

{
    "seller": "dfb888d6-6a5d-4c0e-b7e3-546f0f74a3fb",
    "packages": ["10e0f9a3-7bb3-4f51-8b26-c65888e0a5b6", "0d569eb3-3574-40e9-818b-b3e62a0d1fc1"]
}

What's Next

Retrieving a Shipment