# Counterparty products: Bimp API methods

URL: https://bimpsoft.com/en/help/developers/api-reference/counterparty-nomenclature/

Bimp API methods for the “Counterparty products” resource (`/org2/counterpartyNomenclature/…`): 4 methods. Base URL: `https://app.bimpsoft.com`. All requests except login pass the company token in the `access-token` header — see [Getting started with the API](/en/help/developers/api-getting-started/).

Supplier nomenclature linked to a product

| Method | What it does |
|---|---|
| [`POST /org2/counterpartyNomenclature/api-readList`](#api-read-list) | List supplier nomenclature rows for a given product (nomenclature) |
| [`POST /org2/counterpartyNomenclature/api-create`](#api-create) | Create a supplier nomenclature row for a product |
| [`POST /org2/counterpartyNomenclature/api-update`](#api-update) | Update a supplier nomenclature row |
| [`POST /org2/counterpartyNomenclature/api-delete`](#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)

**Request body (JSON)**

| Field | Type | Required | Description |
|---|---|---|---|
| `nomenclature` | string (uuid) | yes | 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 |

**Response: `data` field**

| Field | Type | Description |
|---|---|---|
| `[].uuid` | string (uuid) |  |
| `[].counterparty` | object |  |
| `[].counterparty.uuid` | string (uuid) |  |
| `[].counterparty.name` | string |  |
| `[].article` | string |  |
| `[].name` | string |  |
| `[].barcode` | string |  |

```bash
curl -X POST 'https://app.bimpsoft.com/org2/counterpartyNomenclature/api-readList' \
  -H 'access-token: <company 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

**Request body (JSON)**

| Field | Type | Required | Description |
|---|---|---|---|
| `nomenclature` | string (uuid) | yes | Our nomenclature GUID this supplier name belongs to |
| `counterparty` | string (uuid) | yes | Supplier (counterparty) GUID |
| `name` | string | yes | Product name as used by the supplier |
| `article` | string |  | Supplier article / SKU |
| `barcode` | string |  | Supplier barcode |

**Response: `data` field**

| Field | Type | Description |
|---|---|---|
| `uuid` | string (uuid) |  |
| `counterparty` | object |  |
| `counterparty.uuid` | string (uuid) |  |
| `counterparty.name` | string |  |
| `article` | string |  |
| `name` | string |  |
| `barcode` | string |  |

```bash
curl -X POST 'https://app.bimpsoft.com/org2/counterpartyNomenclature/api-create' \
  -H 'access-token: <company 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

**Request body (JSON)**

| Field | Type | Required | Description |
|---|---|---|---|
| `uuid` | string (uuid) | yes | Supplier nomenclature row UUID |
| `counterparty` | string (uuid) | yes | Supplier (counterparty) GUID |
| `name` | string | yes | Product name as used by the supplier |
| `article` | string |  | Supplier article / SKU |
| `barcode` | string |  | Supplier barcode |

**Response: `data` field**

| Field | Type | Description |
|---|---|---|
| `uuid` | string (uuid) |  |
| `counterparty` | object |  |
| `counterparty.uuid` | string (uuid) |  |
| `counterparty.name` | string |  |
| `article` | string |  |
| `name` | string |  |
| `barcode` | string |  |

```bash
curl -X POST 'https://app.bimpsoft.com/org2/counterpartyNomenclature/api-update' \
  -H 'access-token: <company 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

**Request body (JSON)**

| Field | Type | Required | Description |
|---|---|---|---|
| `uuids` | string (uuid)[] | yes | Supplier nomenclature row UUIDs to delete |

**Response: `data` field**

| Field | Type | Description |
|---|---|---|
| `deleted` | number |  |

```bash
curl -X POST 'https://app.bimpsoft.com/org2/counterpartyNomenclature/api-delete' \
  -H 'access-token: <company token>' \
  -H 'Content-Type: application/json' \
  -d '{"uuids":["00000000-0000-0000-0000-000000000000"]}'
```

Interactive documentation with a test request option: [https://app.bimpsoft.com/docs](https://app.bimpsoft.com/docs). The OpenAPI specification is updated together with Bimp; this page is generated from it automatically.