features

Integrate with FlavorCloud

Integrating your cross border shipping experience has never been easier!

Direct API integration

Below are the steps for a typical integration flow for creating and tracking shipments using the FlavorCloud APIs.
Step 1: In the checkout flow in your website, call the Post Rates endpoint to retrieve shipping rates for the customer.
o Shipping rates will be served from flavorcloud for the best carrier, service level and route combination.
o You can then surface these rates in your website.
o Rate_hash_key is returned in the response and will be used later to create shipments.
If the terms of trade on the shipment is DDP, then call Landed costs endpoint to retrieve relevant duties and taxes. Duty_hash_key is returned in the response and will be used later to create shipments.
If the terms of trade on the shipment is DDU, you can still call to get an estimate of the duties and taxes by calling Landed costs endpoint though that will not be collected from the customer.

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.
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.
o Include the rate_hash_key and duty_hash_key(if applicable) from the previous step in the request.
o Rerating of the shipment may occur if differences are detected on key fields like origin, destination address, pieces, weight and dimensions.
o Shipment_id is returned in the response and is used for retrieve shipment information.

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
o 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, call Tracking endpoint

Additional scenarios

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.

features