Direct API Integration

Quick, Easy Integration

Integrating your cross border shipping experience in as little as 4 Steps!

Icon_eCommerceIntegration
3PLIntegration_SetUpAccount

Step 1

Retrieve Shipping Rates

Icon_Generic_Logistics_2

Step 2

Register Shipment Created Event

3PLIntegration_AddNewUser

Step 3

Receive Shipping Info

Icon_Generic_Logistics

Step 4

Get Detailed Tracking Info

Additional Scenarios

Dealing with Returns

{

"rate_id": "6a7d75ed471a5",

"reference": "123456",

"currency": "USD",

"standard": {

"ddp": {

"hashkey": "",

"shipping_cost": "152.00",

"discounted_shipping_cost": "152.00",

"carrier": "UPS",

"insurance": "18.00",

"days": "4-6 Business Days"

}

}

}

Step 1

In the checkout flow in your website, call the Post Rates endpoint to retrieve shipping rates for the customer. If the terms of trade on the shipment is DDP, then set “include_landed_cost”: “true” .

  • Shipping rates will be served from flavorcloud for the best carrier, service level and route combination.
  • You can then surface these rates in your website.
  • Rate_hash_key is returned in the response and will be used later to create shipments.
  • Duty_hash_key is returned in the response and will be used later to create shipments.

Step 2

Register for a “SHIPMENT_COMPLETED” event by calling Subscribe to webhook endpoint. You will be notified when the shipment is created via a webhook. Use of the webhook mechanism is recommended.

On completion of checkout, call the Post shipment endpoint to create the shipment in FlavorCloud. This will lead to the selection of the carrier, confirmation of a rate and the generation of the tracking reference, relevant documentation and label.

  • Include the rate_hash_key and duty_hash_key(if applicable) from the previous step in the request.
  • Set the async flag to false to receive the response details (tracking number, label and docs) immediately. In this case, you don’t have register or listen for webhook notifications.
  • Rerating of the shipment may occur if differences are detected on key fields like origin, destination address, pieces, weight and dimensions.
  • Shipment_id is returned in the response and is used for retrieve shipment information.

{

"app_id": "6a7d75ed471a52f7bb81f8506ae78f13",

"rest_api_key": "afdd4ca071316418836dfca3630ae57cc757ca74",

"reference": "reference",

"webHooksList": [

{

"eventName": "shipment-created",

"url": "http://app.flavorcloud.com/api/fulfill-complete"

}

]

}

{

"consolidated_shipment_id": 48,

"tracking_number": "1Z868Y6A8690305101",

"label_url": "http://cdn.flavorcloud.com/shipment-label.pdf"

}

Step 3

When you’re notified of the shipment-completed event via the webhook, you will receive the tracking, docs and label information as part of the webhook callback.

Alternatively (not recommended), you can poll for shipment tracking reference and documents by calling Get shipment endpoint

  • Tracking_number is returned in the response and will be used later to retrieve detailed tracking information.

Certain carriers require creation of consolidation manifest which is used to complete the first mile pickup of the shipment and transport to the carrier consolidation site.

To create a consolidation manifest, call Post manifest shipment endpoint with the list of shipment ids to be added.

Register for a “SHIPMENT_COMPLETED” event by calling Subscribe to webhook endpoint . You will be notified when the shipment is created via a webhook.

To get the consolidation shipment label and docs, call Get manifest shipment endpoint

Step 4

For getting detailed tracking information, Register for a “TRACKING_UPDATES” event by calling Subscribe to webhook endpoint . You will be notified when there are tracking updates via a webhook.

Alternatively, you can call
Tracking endpoint

{

"reference": "123456987",

"tracking_number": "7316998393",

"tracking_history": [

{

"location": "3021 HUMES PL, SEATTLE, WA, US",

"status_date": "2013-03-29T08:58:00.000Z",

"status_detail": "Registered with Clearing Agency.",

"status": "Delivered"

}

]

}

{

"return_shipment_id": "abcdefgh",

"reference": "123456"

}

Dealing with returns

For cases where you need to process a return, call Post return shipment endpoint to create a return shipment. This is very similar to the create shipment in Step 2.

Register for a “shipment-completed” event by calling Subscribe to webhook endpoint . You will be notified when the shipment is created via a webhook.

To get tracking reference and docs for return shipment call Get return shipment endpoint.

To retrieve detailed tracking information for return shipments call Tracking endpoint.

Internationl Shipping has Never Been Easier

Lowest Shipping Rates

Offer a choice of shipping services at the lowest international shipping rates in the industry.

No Surprise Fees

Guaranteed landed cost. Accurate customs duty & tax calculated real-time, at checkout.

Super Simple Integration

Simple integration with no upfront costs or commitment. Our app plugs right into Shopify, and your fulfillment network.

Testimonials

Our Reviews Speak for Themselves

open-quote

advene

Best Fulfillment for International Shipping

We have been using flavorcloud for the past five months and have recommended it to many others, keep the good work!

www.Stemulation.com

Rates are Really Great

I will say that we are very pleased with Flavor Cloud.

Kurly Klips

FlavorCloud is Awesome

I wish I had it eight years ago when I first started my online store.

Mansa Tea

Easy & Seamless

having the shipping fee, duties, & taxes calculated upfront made international shipping easy & seamless. 

KENT | super natural basics

Love this app!

Would definitely recommend to any shopify store owner looking to expand beyond the US.

close-quote

Features

Some of Our Awesome Features

FlavorCloud makes international shipping and returns easy, affordable and friction-free, “anywhere to anywhere”

price

No Seup Costs

subscriptions

No Monthly Subscriptions

shipments

Pay Per Shipment