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

Add Customer

POST
/Customer
Customer
Create Customer with default shipment details

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
PaymentKey
string 
required
PaymentKey
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
Name
string 
required
Name of person. Both name and company can be included
AttentionName
string 
required
Name of attention, if person
AddressLine1
string 
required
First line of the address
AddressLine2
string 
optional
Second line of the address
AddressLine3
string 
optional
Third line of the address
City
string 
required
Full city name
State
string 
optional
State or province
Country
string 
required
ISO 3166 country code for the country the address is located in
Zip
string 
required
ZIP or postal code
Phone
string 
required
Phone number to reach the person or organization
Email
string 
required
Email to reach the person or organization
TaxID
string 
optional
TaxID of the person or organization
ShippingOrigin
object (ShippingOrigin) 
required
LocationName
string 
required
Name of Location
AddressLine1
string 
required
First line of the address
AddressLine2
string 
optional
Second line of the address
AddressLine3
string 
optional
Third line of the address
City
string 
required
Full city name
State
string 
optional
State or province
Country
string 
required
ISO 3166 country code for the country the address is located in
Zip
string 
required
ZIP or postal code
Phone
string 
required
Phone number to reach the person or organization
Email
string 
required
Email to reach the person or organization
AveragePackageSettings
object (AveragePackageSettings) 
optional
Weight
number 
optional
Total average (scaled) weight of the package
Length
number 
optional
Average Length of the parcel
Width
number 
optional
Average of the parcel
Height
number 
optional
Average of the parcel
OriginCountryCode
string 
optional
Height of the parcel
Example
{
  "PaymentKey": "string",
  "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"
  }
}

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 POST 'https://partnerapi.flavorcloud.com/Customer' \
--header 'Content-Type: application/json' \
--data-raw '{
  "PaymentKey": "string",
  "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"
  }
}'

Responses

🟢200Create Customer Response
application/json
Body
CustomerKey
string 
required
CustomerKey
Example
{
  "CustomerKey": "string"
}
🟠401Authentication Error
🟠422Validation Error
🔴500Error Response
Modified at 2025-04-28 20:50:43
Previous
Get Classification
Next
Get Customers
Built with