Skip to main content
When to use this. A sub-supplier is any external company a supplier works with as part of their production network — fabric mills, trim suppliers, printing houses, embroidery workshops, and similar partners. Suppliers maintain their own library, which brand customers can then view to gain supply chain visibility. Use these endpoints to create, update, and query that library on behalf of a supplier organization, or to read sub-suppliers across organizations your account has access to.

The workflow

Sub-suppliers belong to a supplier organization. The typical path is to create the sub-supplier with location and contact details, optionally update or archive it as the relationship evolves, and soft-delete it when it is no longer part of the supply chain.
1

Create the sub-supplier

POST /api/organizations/{organizationId}/sub-suppliers to add one or more sub-suppliers to a specific supplier org, including the primary contact and relation type. Alternatively, use POST /api/sub-suppliers if your token is already scoped to the supplier org.
2

Retrieve or list

GET /api/sub-suppliers/{id} to fetch a single sub-supplier, or GET /api/sub-suppliers to list them with filters (country, relation type, custom ID, free-text search).
3

Update details

PUT /api/sub-suppliers/{id} for a full replace, or PATCH /api/sub-suppliers/{id} for partial JSON Patch updates (e.g. updating only the website or archiving). Use PUT /api/sub-suppliers to update multiple sub-suppliers in a single request.
4

Archive or delete

Set state to archived via PUT or PATCH to hide a sub-supplier from active lists without removing history. Call DELETE /api/sub-suppliers/{id} to soft-delete it and cascade to its contacts and associated facilities.

Walkthrough

Create a sub-supplier under a specific supplier organization. The body is an array — one or many sub-suppliers are created in a single all-or-nothing transaction.
The response wraps the created sub-suppliers in the standard envelope. Hold onto each id (UUID) — you use it for single-record reads, updates, and deletes.

Field reference

The fields that matter most when creating or updating a sub-supplier:

Roles & permissions

Managing a sub-supplier library requires the suppliers permission on a supplier account — SupplierAdmin or SupplierUser. Brand (designer) accounts with access to the Supplier Module can read sub-supplier data via the org-scoped endpoints (GET /api/organizations/{organizationId}/sub-suppliers) but cannot create or modify sub-suppliers on behalf of a supplier organization without an active brand relationship.

When things go wrong

Errors use the standard envelope (status: "error", a code, and error.details[]). See Errors & responses for the full list of codes and how to resolve them. Common cases:
  • 404 — the sub-supplier UUID does not exist or belongs to a different organization.
  • 403 — your account does not have an active brand relationship with the supplier org, or lacks the suppliers permission.
  • 400 — a required field (name, countryCode) is missing, or an enum value (relationType, state) is invalid.

What to call next

Facilities

Register production facility locations for a sub-supplier to build out the supply chain map.

Colors

Manage the brand’s reusable colour library that styles and items reference.

Seasons

Create the seasons that styles are filed under — the top-level collection structure.

Style contacts

Look up the supplier and contact people assigned to a style.

API Reference

Full parameter and response schemas for all sub-supplier endpoints.