FlavorCloud Partner API Documentation
  1. Batches
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. Batches

Create Batch

POST
/Batches
ShipmentBatchesController
This api is used to create batches of shipments. Built with the goal of enabling order aggregation for B2B parcel flow. If your WMS processes multiple shipments in batches, closing the entire batch of shipments as opposed to a single shipment at at time, this api will help to organize and process them together. Creating a batch is the first step. You can then associate shipments to the batch after creation.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
CustomerKey
string 
optional
Customer key
HashKey
string 
optional
The unique key of Individual Rate
DutyHashKey
string 
optional
The unique key of the landed cost
PickUpDate
string 
optional
Shipment PickUpDate (ISO Date) in text format YYYY-MM-DD; EX: 2024-07-30
Async
boolean 
optional
This field for your response for the call as asynchronous or synchronous
Default:
false
Reference
string 
required
This field is for your reference., A good use of it would be to provide your order number here.
BatchID
string 
required
batch identifier string
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
Currency
string 
optional
Currency for the rate, Default is USD
Default:
USD
DimensionUnit
enum<string> 
optional
Unit for dimensions of the shipment. Default is CM
Allowed values:
INCM
Default:
IN
Insurance
enum<string> 
optional
Specify if insurance is required. Default is N
Allowed values:
YN
Default:
N
ServiceCode
enum<string> 
required
Service code. Possible values could be 'STANDARD' | 'EXPRESS' | 'ECONOMY'. Default is STANDARD
Allowed values:
STANDARDEXPRESSSTANDARD-ECONOMYEXPRESS-ECONOMY
TermsOfTrade
enum<string> 
optional
Terms of trade can be Delivery Duty Paid (DDP) or Delivery Duty Unpaid (DDU). Default is DDP
Allowed values:
DDPDDU
Default:
DDP
IsReturn
enum<string> 
optional
You can easily create return labels. All you need to do is set the is_return parameter to "Y".
Allowed values:
YN
Default:
N
ShipmentKey
string 
optional
ShipmentKey is required for Return Shipments
ShipFromAddress
object (ShipFromAddress) 
required
Name
string 
optional
Name of person. Both name and company can be included
Default:
Test Shipper
AttentionName
string 
optional
Name of attention, if person
Default:
Test Shipper
LocationName
string 
optional
This property allows you to supply a specific name of a location you have on your FlavorCloud account. If you supply a name of a location that exists on your FlavorCloud account, the address information for the location will be used. If you supply a name of a location that does not exist on your FlavorCloud account, a new location will be created with the address information supplied
Default:
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 
optional
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
ShipToAddress
object (ShipToAddress) 
required
Name
string 
required
Name of person. Both name and company can be included
Default:
Test consignee
AttentionName
string 
optional
Name of attention, if person
Default:
Test consignee
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 
optional
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
FederalTaxId
string 
optional
Federal tax identifier of the person or organization
StateTaxId
string 
optional
State tax identifier of the person or organization
ReasonForExport
string 
optional
State the key reason for the shipment. Possible values could be 'documents', 'gift', 'merchandise', 'returned_goods', 'sample', or 'other'. Default is 'Merchandise'
Default:
merchandise
Metadata
object (Metadata) 
optional
IndiaExportInfo
object (IndiaExportInfo) 
optional
B2b
boolean 
optional
Enable this flag for Business to business
Default:
false
IsNewShipment
boolean 
optional
A Boolean flag that is used to determine whether a new shipment (label, tracking number and commercial invoice) should be created whenever the same 'Reference' value is provided. If this flag is set to true, a new shipment will be created irrespective of the 'Reference' value passed. Conversely, if this flag is set to false, the API will retrieve the data of the original shipment associated with the provided 'Reference' value, if a shipment already exists The default value of this property is false.
Default:
false
Example
{
  "AppID": "{{app_id}}",
  "RestApiKey": "{{rest_api_key}}",
  "Async": false,
  "Reference": "{{batch_id}}",
  "BatchID": "{{batch_id}}",
  "LabelFormat": "PDF",
  "WeightUnit": "LB",
  "Currency": "USD",
  "DimensionUnit": "IN",
  "Insurance": "N",
  "ServiceCode": "EXPRESS",
  "TermsOfTrade": "DDP",
  "IsReturn": "N",
  "ShipmentKey": "",
  "ShipFromAddress": {
    "Name": "FC Rates",
    "AttentionName": "",
    "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"
  },
  "ReasonForExport": "merchandise"
}

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/Batches' \
--header 'Content-Type: application/json' \
--data-raw '{
    "AppID": "{{app_id}}",
    "RestApiKey": "{{rest_api_key}}",
    "Async": false,
    "Reference": "{{batch_id}}",
    "BatchID": "{{batch_id}}",
    "LabelFormat": "PDF",
    "WeightUnit": "LB",
    "Currency": "USD",
    "DimensionUnit": "IN",
    "Insurance": "N",
    "ServiceCode": "EXPRESS",
    "TermsOfTrade": "DDP",
    "IsReturn": "N",
    "ShipmentKey": "",
    "ShipFromAddress": {
        "Name": "FC Rates",
        "AttentionName": "",
        "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"
    },
    "ReasonForExport": "merchandise"
}'

Responses

🟢200Create Batch
application/json
Body
id
number 
optional
The unique identifier for the batch
customerId
number 
optional
shipmentId
number 
optional
packageJSON
string 
optional
baseRequestJSON
string 
optional
responseJSON
string 
optional
batchId
string 
optional
status
enum<string> 
optional
Allowed values:
OpenFC-ClosedCompleted
createdDate
string <date-time>
optional
The date and time when the batch was created
modifiedDate
string <date-time>
optional
The date and time when the batch was last modified
completedDate
string <date-time>
optional
The date and time when the batch was completed
createdBy
number 
optional
modifiedBy
number 
optional
Example
{
  "id": 0,
  "customerId": 0,
  "shipmentId": 0,
  "packageJSON": "string",
  "baseRequestJSON": "string",
  "responseJSON": "string",
  "batchId": "string",
  "status": "Open",
  "createdDate": "2019-08-24T14:15:22Z",
  "modifiedDate": "2019-08-24T14:15:22Z",
  "completedDate": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "modifiedBy": 0
}
Modified at 2025-04-28 20:49:46
Previous
Get Tracking Detail
Next
Update Batch - Add Shipment
Built with