Sign in
Suppliers

Update a Supplier

This endpoint updates a single supplier for the given organisation.

put/inventory/suppliers/{supplierId}

Request body

namestring

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

emailstring nullable

An email address for the supplier.

phonestring nullable

A phone number for the supplier.

address_1string nullable

The first line of the supplier's address.

address_2string nullable

The second line of the supplier's address.

citystring nullable

The city part of the supplier's address.

countystring nullable

The county part of the supplier's address.

countrystring nullable

The country part of the supplier's address.

postcodestring nullable

The ZIP or postal code part of the supplier's address.

Example request

{
  "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"
}

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

No recorded changes to this endpoint across all 1 revision of this API.