Overview
Yuzu can configure a team as a 3PL partner. A 3PL API key can provision merchant teams, send orders to them, and print their documents without a separate API key for every merchant.
Contact Yuzu before building against these endpoints. A standard merchant-team key receives 403 responses from 3PL-only routes.
Concepts
| Term | Meaning |
|---|---|
| 3PL team | The parent team. It owns the API key and managed-merchant roster. |
| Merchant team | A client managed by the 3PL. Its orders, templates, documents, and reporting remain separate from other merchants. |
| Onboarding | The merchant is being configured and tested. Orders can be ingested and rendered, but automatic printing remains paused. Manual test printing is available. |
| Live | The merchant is ready for production. New eligible orders can print automatically. |
Confirm the team type
Use the current-team endpoint to confirm that Yuzu has configured the authenticated team as three_pl:
GET https://app.yuzu.so/api/teams
{
"id": "org_exampleThreePl123456789",
"name": "Example 3PL",
"slug": "example-3pl",
"type": "three_pl",
"parent_team_id": null,
"status": "live"
}
Onboarding tracker
Every managed merchant starts with a shared onboarding tracker in Yuzu. The tracker assigns work to the merchant, the 3PL, or Yuzu so everyone can see what is complete, what remains, and who owns the next step.
Use the tracker to coordinate store connections, templates, routing, test orders, and test prints. Take the merchant live only after all parties have confirmed the production workflow.
The tracker is an operational tool in the Yuzu dashboard. API integrations do not need to manage its tasks.
Recommended sequence
- Create an API key in the parent 3PL team and verify it with
GET /api/auth/whoami. - Create the merchant team.
- Invite the merchant and assign a 3PL account manager if required.
- Connect the merchant's source app and configure templates, flows, printers, and order routing.
- Validate the 3PL API key and source App ID.
- Send a test order with the merchant's
targetTeamId. - Check the generated documents and complete a manual test print.
- Confirm the onboarding tracker, then take the merchant live.
Shared order APIs
3PL integrations use the same order endpoints as other Yuzu API users:
The 3PL pages document only the additional team and routing behaviour.