Skip to content

Suppliers

View as Markdown

A Supplier is a vendor you buy stock from. It is a lightweight reference resource - a translatable name and not much else - that Purchase offers point at to record who a cost price comes from.

Keeping suppliers as their own resource lets you hold concurrent purchase offers from different vendors for the same variant and compare their costs.

PropertyTypeRequiredDescription
idstring-The resource's unique identifier (UUID).
namestring | null-This property supports translations.

The name of the supplier.
createdAtstring-The date and time when the resource was created (ISO 8601 format).
updatedAtstring-The date and time when the resource was last modified (ISO 8601 format).
  • Onboard a vendor. Create a supplier with its name, then reference it from the Purchase offers that record its prices.
  • Compare sourcing. Keep a purchase offer per supplier for the same variant to track which vendor is cheapest over time.
  • Localize the name. Read or write the translatable name per locale with the X-Flowkiwi-Locale header.

All requests require an OAuth 2.0 bearer token and the organization scope header:

Authorization: Bearer <token>
X-Flowkiwi-Organization-Id: <organization-id>

For the translatable name, set the active locale (and optionally a fallback):

X-Flowkiwi-Locale: fr-FR
X-Flowkiwi-Locale-Fallback: en-US

PATCH uses JSON Merge Patch with Content-Type: application/merge-patch+json.