Номенклатура контрагента: методи API Bimp

Методи API Bimp для ресурсу «Номенклатура контрагента» (/org2/counterpartyNomenclature/…): 4 методи. Базова адреса: https://app.bimpsoft.com. Усі запити, крім входу, передають токен компанії в заголовку access-token — див. Початок роботи з API.

Supplier nomenclature linked to a product

Метод	Що робить
`POST /org2/counterpartyNomenclature/api-readList`	List supplier nomenclature rows for a given product (nomenclature)
`POST /org2/counterpartyNomenclature/api-create`	Create a supplier nomenclature row for a product
`POST /org2/counterpartyNomenclature/api-update`	Update a supplier nomenclature row
`POST /org2/counterpartyNomenclature/api-delete`	Delete one or more supplier nomenclature rows

api-readList

POST /org2/counterpartyNomenclature/api-readList

List supplier nomenclature rows for a given product (nomenclature)

Тіло запиту (JSON)

Поле	Тип	Обов’язкове	Опис
`nomenclature`	string (uuid)	так	Nomenclature GUID whose supplier names should be listed
`counterparty`	string (uuid)		Optional counterparty GUID filter
`search`	string		Partial match across counterparty name, supplier product name and barcode

Відповідь: поле data

Поле	Тип	Опис
`[].uuid`	string (uuid)
`[].counterparty`	object
`[].counterparty.uuid`	string (uuid)
`[].counterparty.name`	string
`[].article`	string
`[].name`	string
`[].barcode`	string

curl -X POST 'https://app.bimpsoft.com/org2/counterpartyNomenclature/api-readList' \
  -H 'access-token: <токен компанії>' \
  -H 'Content-Type: application/json' \
  -d '{"nomenclature":"00000000-0000-0000-0000-000000000000"}'

api-create

POST /org2/counterpartyNomenclature/api-create

Create a supplier nomenclature row for a product

Тіло запиту (JSON)

Поле	Тип	Обов’язкове	Опис
`nomenclature`	string (uuid)	так	Our nomenclature GUID this supplier name belongs to
`counterparty`	string (uuid)	так	Supplier (counterparty) GUID
`name`	string	так	Product name as used by the supplier
`article`	string		Supplier article / SKU
`barcode`	string		Supplier barcode

Відповідь: поле data

Поле	Тип	Опис
`uuid`	string (uuid)
`counterparty`	object
`counterparty.uuid`	string (uuid)
`counterparty.name`	string
`article`	string
`name`	string
`barcode`	string

curl -X POST 'https://app.bimpsoft.com/org2/counterpartyNomenclature/api-create' \
  -H 'access-token: <токен компанії>' \
  -H 'Content-Type: application/json' \
  -d '{"nomenclature":"00000000-0000-0000-0000-000000000000","counterparty":"00000000-0000-0000-0000-000000000000","name":"string"}'

api-update

POST /org2/counterpartyNomenclature/api-update

Update a supplier nomenclature row

Тіло запиту (JSON)

Поле	Тип	Обов’язкове	Опис
`uuid`	string (uuid)	так	Supplier nomenclature row UUID
`counterparty`	string (uuid)	так	Supplier (counterparty) GUID
`name`	string	так	Product name as used by the supplier
`article`	string		Supplier article / SKU
`barcode`	string		Supplier barcode

Відповідь: поле data

Поле	Тип	Опис
`uuid`	string (uuid)
`counterparty`	object
`counterparty.uuid`	string (uuid)
`counterparty.name`	string
`article`	string
`name`	string
`barcode`	string

curl -X POST 'https://app.bimpsoft.com/org2/counterpartyNomenclature/api-update' \
  -H 'access-token: <токен компанії>' \
  -H 'Content-Type: application/json' \
  -d '{"uuid":"00000000-0000-0000-0000-000000000000","counterparty":"00000000-0000-0000-0000-000000000000","name":"string"}'

api-delete

POST /org2/counterpartyNomenclature/api-delete

Delete one or more supplier nomenclature rows

Тіло запиту (JSON)

Поле	Тип	Обов’язкове	Опис
`uuids`	string (uuid)[]	так	Supplier nomenclature row UUIDs to delete

Відповідь: поле data

Поле	Тип	Опис
`deleted`	number

curl -X POST 'https://app.bimpsoft.com/org2/counterpartyNomenclature/api-delete' \
  -H 'access-token: <токен компанії>' \
  -H 'Content-Type: application/json' \
  -d '{"uuids":["00000000-0000-0000-0000-000000000000"]}'

Інтерактивна документація з можливістю надіслати тестовий запит: https://app.bimpsoft.com/docs. Специфікація OpenAPI оновлюється разом із Bimp; ця сторінка згенерована з неї автоматично.