Suppliers

Create a new Supplier

Changed on

OAuth Scope

This endpoint requires the following OAuth scope manage_suppliers.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

post/supplier.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/supplier.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: manage_suppliers

Request body

uuidstring uuid

Unique identifier for this record

namestring

The name of the supplier company

business_numberstring

Business registration number (e.g., ABN, EIN)

addressstring

Physical address of the supplier store

emailstring email

Primary contact email address

phonestring

Primary contact phone number

account_numberstring

Your account number with this supplier

Example request

{
  "uuid": "123e4567-827b-4718-855f-23f94cee909b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes