Sign in
Suppliers

Create a Supplier

This endpoint creates a supplier for the given organisation.

post/inventory/suppliers

Request body

namestring required

Trading name of the inventory supplier, shown on purchase orders and supplier reports. Trimmed; 1-120 characters, must not contain HTML.

site_idstring uuid required

Identifier of the site that owns this supplier record. Supplier records are scoped per site so each site can maintain its own supplier list, terms, and contact info.

Example request

{
  "name": "Elemis"
}

Response

The supplier was successfully retrieved

Example response

{
  "data": {
    "name": "Elemis",
    "email": "orders@example.com",
    "phone": "+44 20 8012 3456",
    "address_1": "Unit E, Dominion Way",
    "address_2": "Rustington",
    "city": "Littlehampton",
    "county": "West Sussex",
    "country": "UK",
    "postcode": "BN16 3HQ"
  }
}

Changes