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

    Getting Started Guide for 3PLs

    Third-party logistics providers (3PLs) can seamlessly integrate with FlavorCloud to become end-to-end international shipping providers, for both shipping and returns. Integration unlocks the best carriers and rates for your merchants, seamless handling of customs, landed costs, and compliance, as well as end-to-end customer service from pickup to delivery.
    Are you a merchant?
    The Getting Started Guide is a little different for you. View the Merchant Guide →

    Integration steps#

    1
    Set up a FlavorCloud account
    Follow the Getting Started Guide for Merchants to set up a FlavorCloud App and retrieve your AppID and RestApiKey.
    2
    Have the merchant add you as a 3PL user
    The merchant adds a 3PL user from the Users tab in their FlavorCloud account. Provide your FlavorCloud login email to the merchant so they can grant access.
    An email is then sent to the 3PL containing a customer_key. When making API calls on behalf of this merchant, pass the customer_key in the request alongside your AppID and RestApiKey.
    3
    Integrate fulfillment with FlavorCloud
    Register for the SHIPMENT_COMPLETED event via the Subscribe Webhooks endpoint — you'll be notified when shipments are created. This is the recommended method.
    Alternatively, call the Create Shipments endpoint with the Async flag set to false and retrieve tracking and labels directly in the response.
    At the time of order fulfillment, call Create Shipments from your WMS. This creates a shipment in FlavorCloud, selects the appropriate carrier and rate based on what was chosen at checkout, and generates the label, customs documentation, and tracking number.
    Include AppID, RestApiKey, customer_key, HashKey, DutyHashKey, Reference, and ReasonForExport in the request.
    Async flag behavior:
    Async: false → response includes ShipmentID along with label, customs doc, and tracking number links.
    Async: true → response returns ShipmentID only. Label, customs doc, and tracking number links arrive via the SHIPMENT_COMPLETED webhook callback.
    Rate invalidation on field changes
    Changes or overrides to any of the following fields will invalidate the rate chosen at checkout and trigger a new rate calculation upon fulfillment:
    ShipFromAddress
    ShipToAddress
    TermsOfTrade
    ServiceCode
    Carrier
    Pieces
    Weight
    Package.Weight

    Next steps#

    Merchant Guide
    Best practices and common setups for the FlavorCloud API, including rates, shipments, manifesting, and tracking.
    API Reference
    Full endpoint documentation, parameters, and response schemas.
    Modified at 2026-04-29 20:19:45
    Previous
    B2B International Shipping Guide
    Next
    Returns Guide
    Built with