> ## Documentation Index
> Fetch the complete documentation index at: https://docs.goshippo.com/llms.txt
> Use this file to discover all available pages before exploring further.

<AgentInstructions>

## Submitting Feedback

If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:

POST https://docs.goshippo.com/feedback

```json
{
  "path": "/docs/Partner_Integration/flow",
  "feedback": "Description of the issue"
}
```

Only submit feedback when you have something specific and actionable to report.

</AgentInstructions>

# Data flow sequence

> View data flow diagrams showing how merchants, platforms, Shippo, and carriers interact during label purchase and tracking.

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.

<Info>
  **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`.
</Info>

## Label purchase flow

```mermaid theme={null}
%%{init: {'theme': 'neutral', 'width': '100%'}}%%
sequenceDiagram
    participant E-commerce Platform as E-commerce<br /> Platform
    participant Merchant Dashboard as Merchant<br /> Dashboard
    participant Shippo API as Shippo<br /> API
    participant Shipping Carrier as Shipping<br /> Carrier
    participant Customer Email/SMS as Customer<br /> Email/SMS
    participant Customer Account Portal as Customer<br /> Account<br /> Portal

    Note left of E-commerce Platform: E-commerce<br /> Checkout &<br /> Label Purchase
    E-commerce Platform ->> Shippo API: Request shipping rates<br /> (Shipments Endpoint)
    Shippo API ->> E-commerce Platform: Return available<br /> shipping rates
    E-commerce Platform ->> Shippo API: Purchase selected<br /> shipping label<br /> (Transactions Endpoint)
    Shippo API -->> E-commerce Platform: Return shipping label<br /> & tracking number <br />via Webhook

    Note left of E-commerce Platform: Provide Tracking<br /> to Merchant
    E-commerce Platform -->> Merchant Dashboard: Display<br /> tracking<br /> number in<br /> dashboard
    Merchant Dashboard ->> Shippo API: Manual lookup<br /> for shipment<br /> status (optional)<br /> (Tracking Endpoint)
    Shippo API -->> Merchant Dashboard: Return shipment<br /> status
    E-commerce Platform -->> Merchant Dashboard: Display<br /> automated<br /> shipment<br /> updates<br /> (optional)

    Note left of E-commerce Platform: Notify Customer
    E-commerce Platform ->> Customer Email/SMS: Send tracking number<br /> & link via Email/SMS
    E-commerce Platform ->> Customer Account Portal: Update tracking number<br /> & link in account portal

    Note left of E-commerce Platform: Customer Tracking
    Customer Email/SMS -->> Shipping Carrier: Redirect<br /> customer<br /> to carrier's<br /> tracking page<br /> (via link)
    Customer Account Portal -->> Shipping Carrier: Redirect customer<br /> to carrier's<br /> tracking page<br /> (via link)

    Note left of E-commerce Platform: Real-time Status<br /> & Handling<br /> Exceptions
    Shipping Carrier ->> Shippo API: Update shipment<br /> status in real-time
    Shippo API ->> E-commerce Platform: Push real-time<br /> status updates
    E-commerce Platform ->> Merchant Dashboard: Display<br /> status & <br />alerts on<br /> exceptions <br /> (e.g., delivery failed)
    E-commerce Platform ->> Customer Email/SMS: Send status updates<br /> or exception alerts <br /> (optional)
    Merchant Dashboard ->> Shipping Carrier: Contact for<br /> resolution on exceptions<br /> (if needed)
```

## Instalabel single call label purchase flow

The following flow includes the purchase of a label using the Shippo [Instalabel](/docs/Guides_general/Single_call) single call label generation.

```mermaid theme={null}
%%{init: {'theme':'neutral', 'width': '100%'}}%%
sequenceDiagram
    participant E-commerce Platform as E-commerce<br /> Platform
    participant Merchant Dashboard as Merchant<br /> Dashboard
    participant Shippo API as Shippo<br /> API
    participant Shipping Carrier as Shipping<br /> Carrier
    participant Customer Email/SMS as Customer<br /> Email/SMS
    participant Customer Account Portal as Customer<br /> Account<br /> Portal

    Note left of E-commerce Platform: E-commerce<br /> Checkout &<br /> Label Purchase
    E-commerce Platform ->> Shippo API: Purchase<br /> selected<br /> shipping label<br /> (Transactions Endpoint)
    Shippo API -->> E-commerce Platform: Return shipping<br /> label & tracking number<br /> via Webhook

    Note left of E-commerce Platform: Provide Tracking<br /> to Merchant
    E-commerce Platform -->> Merchant Dashboard : Display<br /> tracking<br /> number in<br /> dashboard
    Merchant Dashboard ->> Shippo API: Manual lookup<br /> for shipment<br /> status<br /> (optional)<br /> (Tracking Endpoint)
    Shippo API -->> Merchant Dashboard: Return shipment status
    E-commerce Platform -->>  Merchant Dashboard : Display<br /> automated<br /> shipment<br /> updates<br /> (optional)

    Note left of E-commerce Platform: Notify Customer
    E-commerce Platform ->> Customer Email/SMS: Send tracking number<br /> & link via Email/SMS
    E-commerce Platform ->> Customer Account Portal: Update tracking number<br /> & link in account portal

    Note left of E-commerce Platform: Customer Tracking
    Customer Email/SMS -->> Shipping Carrier: Redirect<br /> customer<br /> to carrier's<br /> tracking page<br /> (via link)
    Customer Account Portal -->> Shipping Carrier: Redirect<br /> customer<br /> to carrier's<br /> tracking page<br /> (via link)

    Note left of E-commerce Platform: Real-time<br /> Status<br /> & Handling<br /> Exceptions
    Shipping Carrier ->> Shippo API: Update<br /> shipment<br /> status in<br /> real-time
    Shippo API ->> E-commerce Platform: Push real-time status updates
    E-commerce Platform ->> Merchant Dashboard: Display<br /> status<br /> & alerts on<br /> exceptions<br /> (e.g., delivery failed)
    E-commerce Platform ->> Customer Email/SMS: Send status <br />updates or<br /> exception alerts<br /> (optional)
    Merchant Dashboard ->> Shipping Carrier: Contact for <br />resolution on exceptions<br /> (if needed)
```