POST https://partnerapi.flavorcloud.com/Rates — View endpoint reference →Standard and Express. When you have the full address, parcel, and package information for a shipment, you can use the Rates endpoint to calculate accurate total costs.{
"ShipFromAddress": {
"Name": "The Tap Inc.",
"AttentionName": "Jimmy Owens",
"AddressLine1": "2100 Olson Street",
"City": "San Francisco",
"State": "CA",
"Country": "US",
"Zip": "30320",
"Phone": "4049300178",
"Email": "jimmy.owens@tap.com"
},
"ShipToAddress": {
"Name": "American Retail",
"AttentionName": "Lacy Reed",
"AddressLine1": "305 Water St",
"AddressLine2": "",
"AddressLine3": "",
"City": "Vancouver",
"State": "BC",
"Country": "CA",
"Zip": "V6B 1B9",
"Phone": "1111111111",
"Email": "lacy.reed@american.com"
}
}ShipFromAddress, the Name field is where the business name should be placed. In our example that is "The Tap Inc.".AttentionName is still relevant for other logistical aspects of the shipment process. Providing the correct Name and AttentionName ensures that the shipment is in full compliance with import and export regulations in the destination country. Accurate sender details help customs authorities identify the sender and the nature of the goods, facilitating smooth customs clearance.Name and AttentionName of the ShipToAddress are equally important. The Name is the consignee business name, and an accurate AttentionName ensures the package is delivered to the intended person or department within the consignee organization, avoiding confusion or misdelivery.ReasonForExport should state Sold / Commercial Transaction. This is a declaration to import and export authorities that the shipment is for commercial use. Customs duties and taxes are also often calculated differently for commercial shipments.Name of both sender and consignee should be the business names.AttentionName of both sender and consignee should be specific — for example, "Shipping and Receiving Department" or "Mr. Carlos Rodriguez".ReasonForExport should be "Sold / Commercial Transaction".HashKey, which is important for maintaining the accuracy of the chosen rate as orders are fulfilled through the FlavorCloud API. For businesses new to logistics, we recommend starting with DDP rates. These rates cover taxes, duties, and fees upfront, preventing surprise costs for customers and providing a smoother experience.POST https://partnerapi.flavorcloud.com/Shipments — View endpoint reference →HashKey to ensure the accuracy of the selected rate from FlavorCloud's network.Reference for each shipment, preferably your order number. This unique reference is mandatory.HashKey will be rated based on the provided ServiceCode and TermsOfTrade.B2bLocationNameFederalTaxIdStateTaxIdB2b flag. Set "B2b": true in the request to indicate this is a B2B shipment. This flag drives specific verbiage on the commercial invoice indicating the products are for commercial purposes — REASON FOR EXPORT: Sold / Commercial Transaction.LocationName field. Businesses with multiple shipping locations should establish a naming convention for those locations and store them within their own systems. A good example:SanFrancisco-CA-1FederalTaxId and StateTaxId fields. The FederalTaxId field acts as the primary field for any country-level tax identifier. If you're shipping to Great Britain and provide a UTR (Unique Tax Reference), it goes in this field. Many countries have specific regulations and requirements for importing goods, especially for commercial purposes. When FlavorCloud acts as the Importer of Record, it assumes responsibility for customs declarations and compliance with import regulations. Providing the federal or state tax ID of the receiving business helps accurately identify the importer for customs purposes.LabelUrl for sending off your package.CustomsInvoiceURL must be attached to the shipment. You'll know it was not electronically filed because your LabelUrl will provide a merged label with two pages: the first being the label, the second a copy of the commercial invoice.If the ReasonForExportfield is any ofdocumentsormerchandise, we render Sold / Commercial Transaction for the Reason For Export field on the commercial invoice we generate.
ReasonForExport, FlavorCloud defaults to Merchandise or Sold / Commercial Transaction. If the B2b flag is set and no value is passed for ReasonForExport, the system also falls back to that default.POST https://partnerapi.flavorcloud.com/Webhooks/Subscribe — View endpoint reference →TRACKING_UPDATES event. Each subscription request requires the EventName you want to subscribe to and a URL where FlavorCloud can deliver the event payload.TRACKING_UPDATES fires, FlavorCloud sends a POST request to your subscribed URL with a payload like:{
"event": "tracking-updates",
"tracking_number": 2846127944637,
"appId": "2v5j8w3c6r4b9d7m1k0n3p2x786o24",
"shipmentId": 18672984,
"trackingHistory": [
{
"status": "In Progress",
"status_detail": "Parcel Data Received, Shipment In Route To US Export Warehouse",
"status_date": "2022-04-10 17:15:57",
"location": "East Rutherford, NJ",
"country": "United States"
},
{
"status": "In Progress",
"status_detail": "Shipment created and label generated APC NJ",
"status_date": "2022-04-09 12:41:12",
"location": "",
"address": ""
}
]
}GET https://partnerapi.flavorcloud.com/Tracking/{AppID}/{RestApiKey}/{TrackingNumber} — View endpoint reference →GET request to the Tracking API, providing your AppID, RestApiKey, and the TrackingNumber of the shipment. You'll get all the details to stay in the loop and keep your customers informed throughout the delivery process.