Upsert Supplier

Create or update a supplier.

POST

/api/v1/suppliers

Create or update a supplier. If id is provided, updates by id. Otherwise, if externalId is provided, finds by externalId and updates or creates if not found. If neither is provided, creates a new supplier.

Authorization

AuthorizationBasic <token>

Basic API key authentication. Create a new API key and secret in the Recommand dashboard.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id?string

The internal ID of the supplier to update. If provided, updates by id.

name*string

The name of the supplier

externalId?|

The external ID of the supplier. If provided without id, finds by externalId and updates or creates if not found.

vatNumber?|

The VAT number of the supplier

peppolAddresses?array<string>

The Peppol addresses of the supplier

Default[]

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/suppliers" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "success": true,  "supplier": {    "id": "string",    "teamId": "string",    "externalId": "string",    "name": "string",    "vatNumber": "string",    "peppolAddresses": [      "string"    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "labels": [      {        "colorHex": "#3B82F6",        "externalId": "erp-routing-inbox",        "id": "lbl_01JQZ8X0M4T7RB6K9V2NDHW3PA",        "name": "ERP"      }    ]  }}

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`