Data flow sequence

The following flows represent typical interactions between a Merchant, e-Commerce platform, Carrier, and Shippo. Use these flows to understand how to design your Shippo integration. These flows show the flow of data between Shippo and a platform partner using the Shippo API.

note

Dashed lines show dependencies. For example, before the Shippo API can Return available shipping rates to the E-commerce Platform, the E-commerce Platform must Request shipping rate.

Label purchase flow

E-commerce PlatformMerchant DashboardShippo APIShipping CarrierCustomer Email/SMSCustomer Account PortalE-commerce Checkout & Label PurchaseProvide Tracking to MerchantNotify CustomerCustomer TrackingReal-time Status & Handling ExceptionsRequest shipping rates (Shipments Endpoint)Return available shipping ratesPurchase selected shipping label (Transactions Endpoint)Return shipping label & tracking number via WebhookDisplay tracking number in dashboardManual lookup for shipment status (optional) (Tracking Endpoint)Return shipment statusDisplay automated shipment updates (optional)Send tracking number & link via Email/SMSUpdate tracking number & link in account portalRedirect customer to carrier's tracking page (via link)Redirect customer to carrier's tracking page (via link)Update shipment status in real-timePush real-time status updatesDisplay status & alerts on exceptions (e.g., delivery failed)Send status updates or exception alerts (optional)Contact for resolution on exceptions (if needed)E-commerce PlatformMerchant DashboardShippo APIShipping CarrierCustomer Email/SMSCustomer Account Portal

Instalabel single call label purchase flow

The following flow includes the purchase of a label using the Shippo Instalabel single call label generation.

E-commerce PlatformMerchant DashboardShippo APIShipping CarrierCustomer Email/SMSCustomer Account PortalE-commerce Checkout & Label PurchaseProvide Tracking to MerchantNotify CustomerCustomer TrackingReal-time Status & Handling ExceptionsPurchase selected shipping label (Transactions Endpoint)Return shipping label & tracking number via WebhookDisplay tracking number in dashboardManual lookup for shipment status (optional) (Tracking Endpoint)Return shipment statusDisplay automated shipment updates (optional)Send tracking number & link via Email/SMSUpdate tracking number & link in account portalRedirect customer to carrier's tracking page (via link)Redirect customer to carrier's tracking page (via link)Update shipment status in real-timePush real-time status updatesDisplay status & alerts on exceptions (e.g., delivery failed)Send status updates or exception alerts (optional)Contact for resolution on exceptions (if needed)E-commerce PlatformMerchant DashboardShippo APIShipping CarrierCustomer Email/SMSCustomer Account Portal