FlavorCloud Partner API Documentation
    • Getting Started Guide for Merchants
    • B2B International Shipping Guide
    • Getting Started Guide for 3PLs
    • Returns Guide
    • Authentication
      • Get Auth Token
        POST
    • Rates
      • Get Rates
        POST
      • Get Multi 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
    • Schemas
      • Schemas
        • ClassificationStatus
        • ProductResponse
        • ClassificationResponse
        • MissingProperty
        • ResponseDetails
        • ResponseData
        • ErrorResponse
        • ClassificationProduct
        • ClassificationRequest
        • InvoiceResponse
        • CustomerResponse
        • AccountInformation
        • ShippingOrigin
        • AveragePackageSettings
        • CreateCustomerRequest
        • CreateCustomerResponse
        • GetCustomerResponse
        • LandedCostResponse
        • Piece
        • Address
        • LandedCostRequest
        • CreateManifestShipmentResponse
        • CreateManifestShipmentRequest
        • GetManifestShipmentResponse
        • RateDetailDDU
        • LandedCostDetail
        • RateDetailDDP
        • TradeModel
        • RatesResponse
        • QuoteToAddress
        • QuoteFromAddress
        • QuotePiece
        • Package
        • QuoteRequest
        • RateRequest
        • ShipmentPackage
        • ShipmentsModel
        • MultiRateRequest
        • ShipmentsModelQuote
        • MultiQuoteRequest
        • RateDetailReponse
        • ShipmentBatches
        • ShipFromAddress
        • ShipToAddress
        • IndiaExportInfo
        • Metadata
        • BatchRequest
        • BatchUpdateReqModel
        • BatchCloseReqModel
        • ShipmentBatchesResponseModel
        • ShipmentResponse
        • ShipmentResponseExcluding_ConsolidateLabel_
        • ShipmentRequest
        • CancelShipmentResponse
        • CancelShipmentRequest
        • TrackingHistory
        • TrackingAPIResponse
        • CreateWebhookResponse
        • WebHookInfo
        • SubscribeWebhooksRequest
        • UnSubscribeWebhookRequest

    B2B International Shipping Guide

    Welcome to the comprehensive guide on streamlining your B2B international shipments. Navigating the intricate landscape of global commerce can be a complicated process, and FlavorCloud empowers your business with the tools and insights necessary to effortlessly manage international shipments. This guide shows you how to leverage our API to seamlessly implement and empower your international B2B shipping operations — making development easier, optimizing cost management, streamlining customs compliance, improving delivery experiences, and heightening operational efficiency.
    For a more granular look at the requests in this guide, see the API reference.
    New to FlavorCloud?
    Start with the Getting Started Guide for Merchants for general account setup and core API concepts before diving into B2B-specific configuration.
    Before starting, you will need to sign up for a FlavorCloud account and acquire your API credentials. In the FlavorCloud Admin under API, click New credential set to generate an Application ID and Rest API Key. Or sign up here if you don't yet have an account.

    Retrieving Rates#

    POST https://partnerapi.flavorcloud.com/Rates — View endpoint reference →
    Before shipping internationally, it's critical to provide your business customers with accurate shipping methods and terms of trade. FlavorCloud offers two key Incoterms: Delivered Duty Paid (DDP) and Delivered Duty Unpaid (DDU).
    Business customers can also choose from shipping methods such as 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.
    It is important to note the weight of the combined pieces should not exceed the weight of the entire package. If these differ, we will use the higher weight between the package and the combined weight of the pieces. Retrieving rates for B2B shipments is similar to B2C shipments — before seeing the full example, let's first focus on the two address components:
    {
      "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"
      }
    }
    In the ShipFromAddress, the Name field is where the business name should be placed. In our example that is "The Tap Inc.".
    While FlavorCloud acts as Importer of Record, the 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.
    The 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.
    Clear and accurate labeling of the consignee's details helps customs authorities identify the correct consignee and ensure the shipment meets all regulatory requirements. Incorrect or incomplete information can lead to delays in customs clearance and potential fines.
    With each rate retrieval and fulfillment of your shipment, your 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.
    Insurance for high-value shipments
    Our network offers an insurance option on all shipments. We highly recommend the insured option as a best practice for all high-value B2B shipments. Read more about FlavorCloud insurance.

    Key takeaways#

    The Name of both sender and consignee should be the business names.
    The AttentionName of both sender and consignee should be specific — for example, "Shipping and Receiving Department" or "Mr. Carlos Rodriguez".
    Your ReasonForExport should be "Sold / Commercial Transaction".
    Below is what the full request looks like for rate retrieval:

    Example#

    Request
    Response
    After receiving rates, you can tailor how the rates are displayed at checkout. You can also choose how to invoice your customers using the provided rates through our API — for instance, by modifying the shipping cost based on your business's pricing approach.
    Each shipping rate comes with a unique 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.

    Creating a shipment#

    POST https://partnerapi.flavorcloud.com/Shipments — View endpoint reference →
    For B2B shipments, the fulfillment process involves generating a shipment based on your chosen rate. This is where you'll use the associated HashKey to ensure the accuracy of the selected rate from FlavorCloud's network.
    Consistency is vital during shipment creation — the shipment's components and packaging must align precisely with the previously requested rate.
    You should also assign a unique Reference for each shipment, preferably your order number. This unique reference is mandatory.
    Rates without a HashKey
    Shipments created without a HashKey will be rated based on the provided ServiceCode and TermsOfTrade.

    Enabling B2B for shipments#

    Your shipment request will look very similar to the rate request, with a few B2B-specific additions:
    B2b
    LocationName
    FederalTaxId
    StateTaxId
    The B2b 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.
    There's no actual regulatory requirement to list a reason for export/shipment/import statement, but it does help customs understand why the goods are being sent — to facilitate entry, identify what type of shipment it is (gift, replacement, sample, etc.), determine how duty and tax are to be assessed, and decide what type of entry under which it should be lodged.
    The 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-1
    Here we've used the city, followed by the state, and the location number for that region where multiple distribution centers or warehouses may exist.
    The FederalTaxId 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.

    Example#

    Request
    Response
    The response contains relevant shipping information — the most important being the LabelUrl for sending off your package.
    As your Importer of Record, FlavorCloud electronically files customs documents on your behalf. However, some countries do not accept electronic filing — in those cases, your 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.

    B2B vs B2C reason-for-export statements#

    There isn't any specific statement for B2B shipments versus B2C shipments — rather, the statement depends on what values are passed via API:
    If the ReasonForExport field is any of documents or merchandise, we render Sold / Commercial Transaction for the Reason For Export field on the commercial invoice we generate.
    If no value is passed for 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.

    Pickup process#

    FlavorCloud takes care of every aspect of the shipping process — first mile, global mile, and last mile. If you don't already have scheduled pickup arrangements with the carrier, follow this guide for setting up a pickup.

    Webhooks for tracking and updates#

    POST https://partnerapi.flavorcloud.com/Webhooks/Subscribe — View endpoint reference →
    In the realm of B2B shipments, tracking is pivotal for several reasons. It fosters trust by assuring partners of timely deliveries, enhances the efficiency of intricate supply chains by offering real-time visibility, and safeguards valuable goods against potential risks.
    We recommend leveraging webhook events for tracking updates rather than polling the Tracking API. This way, shipment updates flow to your downstream systems and customers efficiently and in a streamlined manner.
    Below is an example of subscribing to the TRACKING_UPDATES event. Each subscription request requires the EventName you want to subscribe to and a URL where FlavorCloud can deliver the event payload.

    Example#

    Request
    Response

    Sample webhook payload#

    When 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": ""
        }
      ]
    }

    Tracking API#

    GET https://partnerapi.flavorcloud.com/Tracking/{AppID}/{RestApiKey}/{TrackingNumber} — View endpoint reference →
    FlavorCloud also offers a straightforward way to track packages using our API. Make a 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.

    Example#

    Request
    Response

    Conclusion#

    B2B shipments are the backbone of global commerce, driving supply chains and growth. Precision in these shipments is vital for strong relationships, meeting deadlines, and cost control.
    FlavorCloud's API revolutionizes B2B shipping. Real-time insights empower proactive decisions. Accurate labeling and tracking ensure timely delivery, enhancing customer satisfaction. Compliance with international regulations reduces customs delays and costs. Integrating FlavorCloud's API means precise, efficient, and cost-effective B2B shipments — amplifying global success.

    Next steps#

    Merchant Guide
    Best practices and common setups for the FlavorCloud API.
    Returns Guide
    How to handle returns end-to-end with the FlavorCloud API.
    API Reference
    Full endpoint documentation, parameters, and response schemas.
    Modified at 2026-06-23 17:53:37
    Previous
    Getting Started Guide for Merchants
    Next
    Getting Started Guide for 3PLs
    Built with