GENERAL INFORMATION
Purpose
This endpoint is used for creating Vendors and updating them if they have been modified.
How the data is used
The vendor is used to be able to filter on open purchase orders in the portal of a specific vendor. It is not mandatory for the purchase orders, making it an optional dataset to share.
Best practices
Make sure to update the vendors on a regular basis, recommended minimum once a day, to ensure the vendor information is complete and in-line with the vendors assigned to the purchase orders.
Ensure that the id you are using in this endpoint aligns with the vendorId you are assigning to the purchase orders in this endpoint POST /PurchaseOrders
For the description use a clear, short description of the vendor.
Example use cases
As a buyer I want to filter on the products coming from a specific vendor so I can make initial distributions for these products.
TECHNICAL INFORMATION
Authentication
Bearer token, information on page POST /Token
Headers
Name | Description | Example |
|---|---|---|
X-Tenant | Tenant code supplied by Wair | “TENANT” |
QueryParameters:
Name | Description | Example |
|---|---|---|
fullLoad | See documentation: Integration core principles | true |
Body example:
{
"vendors": [
{
"vendorId": "02c94b4a-89bf-4c71-b2cc-4d9c75c2891c",
"code": "V01",
"description": "This is my first shoe vendor",
}
]
}Additional information:
Fieldname | Context | Mandatory | Type / max characters |
|---|---|---|---|
vendorId | Unique identifier for this vendor, for example a uuid, needs to be unique across all vendors. If you want to update a vendor, send the vendor again using this id. | Yes | string / 80 characters |
code | A business key of the vendor, often recognizable to users | Yes | string / 60 characters max |
description | The name of the vendor | No, but preffered | string / 255 characters max |
RESPONSE
StatusCodes:
200 = OK
401 = Unauthorized, which means an expired/missing/invalid token
400 = Bad request, see body of the response to check which validation errors have occured
500 = System error, see body of the response to check which error has occured or contact integration support
Body Example:
No body in the response.