FlavorCloud Partner API Documentation
  1. Shipments
FlavorCloud Partner API Documentation
  • Authentication
    • Get Auth Token
      POST
  • Rates
    • Get Rates
      POST
  • Shipments
    • Create Shipments
      POST
    • Get Shipments
      GET
    • Cancel Shipments
      PUT
  • Tracking
    • Get Tracking Detail
      GET
  • Classifications
    • Get Classification
      POST
  • Landed Cost
    • Get Landed Cost
      POST
  • Webhooks
    • Subscribe Webhooks
      POST
    • Unsubscribe Webhooks
      POST
  • Invoices
    • Get Invoice Detail
      GET
    • Get Invoices
      GET
  1. Shipments

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 samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://partnerapi.flavorcloud.com/Shipments/Get/Details?CustomerKey&Reference&ShipmentID&isReturn=false'

Responses

🟢200Get Shipments Response
application/json
Body

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
Previous
Create Shipments
Next
Cancel Shipments
Built with