Get Shipments

GET

/Shipments/Get/Details

Retrieve an existing shipment using the shipment key (ShipmentID) or Reference. The response will contain the tracking number and required docs for the shipment.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://partnerapi.flavorcloud.com/Shipments/Get/Details?CustomerKey=undefined&Reference=undefined&ShipmentID=undefined&isReturn=false' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Get Shipments Response

application/json

Bodyapplication/json

Example

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

🟠401Authentication Error

🟠422Validation Error

🔴500Error Response

Modified at 2025-04-28 20:49:03

Create Shipments

Cancel Shipments