FlavorCloud Partner API Documentation
  1. Customer
FlavorCloud Partner API Documentation
  • Authentication
    • Get Auth Token
      POST
  • Rates
    • Get Rates
      POST
    • Get Rate Detail
      GET
    • Get Multi Quote
      POST
    • Get Multi Rates
      POST
    • Get Quote
      POST
  • Shipments
    • Create Shipments
      POST
    • Get Shipments
      GET
    • Cancel Shipments
      PUT
  • Tracking
    • Get Tracking Detail
      GET
  • Batches
    • Create Batch
      POST
    • Update Batch - Add Shipment
      PUT
    • Update Batch - Remove Shipment
      PUT
    • Close Batch
      POST
    • Get Batch
      GET
  • Classifications
    • Get Classification
      POST
  • Customer
    • Add Customer
      POST
    • Get Customers
      GET
  • Landed Cost
    • Get Landed Cost
      POST
  • Manifest
    • Manifest Shipment
      POST
    • Get Manifest
      GET
  • Webhooks
    • Subscribe Webhooks
    • Unsubscribe Webhooks
  • Invoices
    • Get Invoice Detail
    • Get Invoices
  1. Customer

Get Customers

GET
/Customers/Get/Customer
Customer
Get Customers using CustomerKey

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
CustomerKey
string 
optional
A comma separated list of CustomerKeys

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/Customers/Get/Customer?CustomerKey'

Responses

🟢200Get Customers Response
application/json
Body
array of:
CustomerKey
string 
required
CustomerKey
CustomerInfo
object (CreateCustomerResponse) 
required
LabelFormat
enum<string> 
optional
LabelFormat Default is PDF
Allowed values:
PDFZPL
Default:
PDF
WeightUnit
enum<string> 
optional
Unit for weight of the shipment. Default in KG
Allowed values:
KGLB
Default:
KG
DimensionUnit
enum<string> 
optional
Unit for dimensions of the shipment. Default is CM
Allowed values:
INCM
Default:
CM
Insurance
enum<string> 
optional
Specify if insurance is required. Default is N
Allowed values:
YN
ServiceCode
array[string]
optional
Allowed values:
STANDARDEXPRESSSTANDARD-ECONOMYEXPRESS-ECONOMY
TermsOfTrade
array[string]
optional
Allowed values:
DDPDDU
AccountInformation
object (AccountInformation) 
required
ShippingOrigin
object (ShippingOrigin) 
required
AveragePackageSettings
object (AveragePackageSettings) 
required
PaymentKey
string 
required
PaymentKey
Example
[
  {
    "CustomerKey": "string",
    "CustomerInfo": {
      "LabelFormat": "PDF",
      "WeightUnit": "KG",
      "DimensionUnit": "CM",
      "Insurance": "Y",
      "ServiceCode": [
        [
          "STANDARD",
          "EXPRESS",
          "STANDARD-ECONOMY",
          "EXPRESS-ECONOMY"
        ]
      ],
      "TermsOfTrade": [
        "DDP"
      ],
      "AccountInformation": {
        "Name": "string",
        "AttentionName": "string",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "AddressLine3": "string",
        "City": "string",
        "State": "string",
        "Country": "string",
        "Zip": "string",
        "Phone": "string",
        "Email": "string",
        "TaxID": "string"
      },
      "ShippingOrigin": {
        "LocationName": "string",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "AddressLine3": "string",
        "City": "string",
        "State": "string",
        "Country": "string",
        "Zip": "string",
        "Phone": "string",
        "Email": "string"
      },
      "AveragePackageSettings": {
        "Weight": 0,
        "Length": 0,
        "Width": 0,
        "Height": 0,
        "OriginCountryCode": "string"
      },
      "PaymentKey": "string"
    }
  }
]
🟠401Authentication Error
🟠422Validation Error
🔴500Error Response
Modified at 2025-04-28 20:50:51
Previous
Add Customer
Next
Get Landed Cost
Built with