Update a Supplier

Request

Updates a Supplier (counterparty) of the Location. Send only the fields to change: omitted fields keep their current values. The Business User needs Finances access in the Location; otherwise the request returns 403.

Security

BearerPartnerUser

Path

location_idintegerrequired

Location ID

Example:4564

supplier_idintegerrequired

Supplier ID

Example:4043

Acceptstringrequired

Default:"application/vnd.api.v2+json"

Content-Typestringrequired

Default:"application/json"

Authorizationstringrequired

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired

titlestring

Supplier name. Required on create

Example:"Bloom Beauty Supply"

type_idinteger(type_id)

Legal form:

0 - Legal entity
1 - Individual entrepreneur
2 - Individual

Enum:012

Example:0

innstring

Taxpayer identification number

Example:"1234567890"

kppstring

Tax registration reason code (legal entities)

phonestring(phone)

Phone number

Example:"+13155550142"

emailstring(email)

Email address

Example:"orders@example.com"

contactstring(contact)

Contact person

Example:"Jordan Lee, sales manager"

commentstring(comment)

Comment

addressstring(address)

Address

Example:"100 Main Street, Springfield"

curl -i -X PUT \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/references/suppliers/4564/4043 \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "phone": "+13155550199",
    "comment": "Delivers on Tuesdays"
  }'

Responses

OK

Bodyapplication/json

successboolean

dataobject(Supplier)

A Supplier (counterparty) of the Location. Pass its id as supplier_id in financial transactions and in inventory operations such as a product receipt.

Example:

{
  "id": 4043,
  "company_id": 4564,
  "type_id": 0,
  "type": {
    "id": 0,
    "title": "Legal entity"
  },
  "title": "Bloom Beauty Supply",
  "inn": "1234567890",
  "kpp": "123401001",
  "phone": "+13155550142",
  "email": "orders@example.com",
  "contact": "Jordan Lee, sales manager",
  "comment": "Delivers on Tuesdays",
  "address": "100 Main Street, Springfield"
}

metaArray of any

Response

{
  "success": true,
  "data": {
    "id": 4043,
    "company_id": 4564,
    "type_id": 0,
    "type": { … },
    "title": "Bloom Beauty Supply",
    "inn": "1234567890",
    "kpp": "123401001",
    "phone": "+13155550199",
    "email": "orders@example.com",
    "contact": "Jordan Lee, sales manager",
    "comment": "Delivers on Tuesdays",
    "address": "100 Main Street, Springfield"
  },
  "meta": []
}