Create Shipments

POST

/Shipments

A Shipment is a container for all the information required to generate a shipping label and commercial invoice (in the case of international shipments). This api returns a ShipmentID that can be used to retrieve the necessary docs for the shipment. The shipment call is billable, see your contract for rates.

When creating Shipments, Reference values are required and must be unique. Providing a duplicate Reference value will return the Shipment previously created with that Reference. If a Shipment pertaining to the supplied Reference value is/was canceled, and then resubmit, the response will return the same ShipmentID with a new tracking number.

Request

Header Params

Body Params application/json

Example

{
    
    "Async": false,
    "Reference": "test-create-shipment-001",
    "HashKey": "588d4ff7-9b21-4028-ba2e-333507bf53d8",
    "LabelFormat": "PDF",
    "WeightUnit": "LB",
    "Currency": "USD",
    "DimensionUnit": "IN",
    "Insurance": "N",
    "ServiceCode": "EXPRESS",
    "TermsOfTrade": "DDP",
    "IsReturn": "N",
    "ReasonForExport": "merchandise",
    "B2b": false,
    "ShipmentKey": "",
    "ShipFromAddress": {
        "Name": "FC Rates",
        "AttentionName": "WH1",
        "AddressLine1": "1562 Washington St",
        "AddressLine2": "",
        "AddressLine3": "",
        "City": "San Francisco",
        "State": "CA",
        "Country": "US",
        "Zip": "94109",
        "Phone": "1111111111",
        "Email": "test@test.com"
    },
    "ShipToAddress": {
        "Name": "FC Rates",
        "AttentionName": "FC Rates",
        "AddressLine1": "49 Montcalm Ave",
        "AddressLine2": "",
        "AddressLine3": "",
        "City": "York",
        "State": "ON",
        "Country": "CA",
        "Zip": "M6E 4N8",
        "Phone": "1111111111",
        "Email": "test@test.com"
    },
    "Shipments": [
        {
            "Piece": [
                {
                    "Quantity": 1,
                    "Weight": 0.1,
                    "Length": 1,
                    "Width": 1,
                    "Height": 1,
                    "SalePrice": 10,
                    "HSCode": "610910",
                    "OriginCountryCode": "US",
                    "Description": "T-SHIRT",
                    "SKU": "1234567890",
                    "Material": "",
                    "Category": [
                        "merchandise"
                    ]
                }
            ],
            "Package": {
                "Weight": 0.5,
                "Length": 1,
                "Width": 1,
                "Height": 1,
                "Reference": ""
            }
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://partnerapi.flavorcloud.com/Shipments' \
--header 'Authorization: {{JWT_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    
    "Async": false,
    "Reference": "test-create-shipment-001",
    "HashKey": "588d4ff7-9b21-4028-ba2e-333507bf53d8",
    "LabelFormat": "PDF",
    "WeightUnit": "LB",
    "Currency": "USD",
    "DimensionUnit": "IN",
    "Insurance": "N",
    "ServiceCode": "EXPRESS",
    "TermsOfTrade": "DDP",
    "IsReturn": "N",
    "ReasonForExport": "merchandise",
    "B2b": false,
    "ShipmentKey": "",
    "ShipFromAddress": {
        "Name": "FC Rates",
        "AttentionName": "WH1",
        "AddressLine1": "1562 Washington St",
        "AddressLine2": "",
        "AddressLine3": "",
        "City": "San Francisco",
        "State": "CA",
        "Country": "US",
        "Zip": "94109",
        "Phone": "1111111111",
        "Email": "test@test.com"
    },
    "ShipToAddress": {
        "Name": "FC Rates",
        "AttentionName": "FC Rates",
        "AddressLine1": "49 Montcalm Ave",
        "AddressLine2": "",
        "AddressLine3": "",
        "City": "York",
        "State": "ON",
        "Country": "CA",
        "Zip": "M6E 4N8",
        "Phone": "1111111111",
        "Email": "test@test.com"
    },
    "Shipments": [
        {
            "Piece": [
                {
                    "Quantity": 1,
                    "Weight": 0.1,
                    "Length": 1,
                    "Width": 1,
                    "Height": 1,
                    "SalePrice": 10,
                    "HSCode": "610910",
                    "OriginCountryCode": "US",
                    "Description": "T-SHIRT",
                    "SKU": "1234567890",
                    "Material": "",
                    "Category": [
                        "merchandise"
                    ]
                }
            ],
            "Package": {
                "Weight": 0.5,
                "Length": 1,
                "Width": 1,
                "Height": 1,
                "Reference": ""
            }
        }
    ]
}'

Responses

🟢200Create Shipments Response

application/json

Bodyapplication/json

Example

{
    "ShipmentID": "string",
    "Status": "string",
    "Reference": "string",
    "Message": "string",
    "TrackingNumber": "string",
    "TrackingUrl": "string",
    "LabelUrl": [
        "string"
    ],
    "Carrier": "string",
    "CustomsInvoiceURL": "string",
    "SubmittedElectronically": true
}

🟠401Authentication Error

🟠422Validation Error

🔴500Error Response

Modified at 2025-12-08 14:04:35

Get Multi Rates

Get Shipments