Vendors

Returns vendors

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Query parameters

codestringOptional

clientIdstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

companyNamestring · nullableOptional

emailstring · nullableOptional

phonestring · nullableOptional

contactPersonstring · nullableOptional

descriptionstring · nullableOptional

idstring · uuidOptional

vendorCodestring · nullableOptional

get

/vendors

HTTPcURLJavaScriptPython

GET /vendors HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "companyName": "text",
    "email": "text",
    "phone": "text",
    "contactPerson": "text",
    "description": "text",
    "address": {
      "address1": "text",
      "address2": "text",
      "city": "text",
      "stateProvince": "text",
      "zipPostalCode": "text",
      "country": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "client": {
      "description": "text",
      "ssccCompanyId": "text",
      "companyName": "text",
      "email": "text",
      "phone": "text",
      "contactPerson": "text",
      "taxId": "text",
      "address1": "text",
      "address2": "text",
      "city": "text",
      "stateProvince": "text",
      "zipPostalCode": "text",
      "country": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "vendorCode": "text"
  }
]

Create new vendor

post

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

companyNamestring · nullableOptional

emailstring · nullableOptional

phonestring · nullableOptional

contactPersonstring · nullableOptional

descriptionstring · nullableOptional

clientIdstring · uuid · nullableOptional

vendorCodestring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

post

/vendors

HTTPcURLJavaScriptPython

POST /vendors HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 291

{
  "companyName": "text",
  "email": "text",
  "phone": "text",
  "contactPerson": "text",
  "description": "text",
  "address": {
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostalCode": "text",
    "country": "text"
  },
  "clientId": "123e4567-e89b-12d3-a456-426614174000",
  "vendorCode": "text"
}

application/jsontext/jsonapplication/*+json

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Update an existing vendor

put

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Body

application/jsontext/jsonapplication/*+json

companyNamestring · nullableOptional

emailstring · nullableOptional

phonestring · nullableOptional

contactPersonstring · nullableOptional

descriptionstring · nullableOptional

idstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

idstring · uuidOptional

406

Not Acceptable

text/plainapplication/jsontext/json

put

/vendors

HTTPcURLJavaScriptPython

PUT /vendors HTTP/1.1
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 265

{
  "companyName": "text",
  "email": "text",
  "phone": "text",
  "contactPerson": "text",
  "description": "text",
  "address": {
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostalCode": "text",
    "country": "text"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsontext/jsonapplication/*+json

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Returns a single vendor by id

get

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Path parameters

idstring · uuidRequired

Responses

200

OK

text/plainapplication/jsontext/json

companyNamestring · nullableOptional

emailstring · nullableOptional

phonestring · nullableOptional

contactPersonstring · nullableOptional

descriptionstring · nullableOptional

idstring · uuidOptional

vendorCodestring · nullableOptional

404

Not Found

text/plainapplication/jsontext/json

406

Not Acceptable

text/plainapplication/jsontext/json

get

/vendors/{id}

HTTPcURLJavaScriptPython

GET /vendors/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

{
  "companyName": "text",
  "email": "text",
  "phone": "text",
  "contactPerson": "text",
  "description": "text",
  "address": {
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostalCode": "text",
    "country": "text"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "client": {
    "description": "text",
    "ssccCompanyId": "text",
    "companyName": "text",
    "email": "text",
    "phone": "text",
    "contactPerson": "text",
    "taxId": "text",
    "address1": "text",
    "address2": "text",
    "city": "text",
    "stateProvince": "text",
    "zipPostalCode": "text",
    "country": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "vendorCode": "text"
}

Delete vendor by Id

delete

Authorizations

ApiKey

ApiKeystringRequired

Api key taken from 'Gateway API key' setting.

Path parameters

idstring · uuidRequired

Responses

200

OK

No content

406

Not Acceptable

text/plainapplication/jsontext/json

delete

/vendors/{id}

HTTPcURLJavaScriptPython

DELETE /vendors/{id} HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

No content