> For the complete documentation index, see [llms.txt](https://developer.emporix.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.emporix.io/api-references-1/readme/api-reference-40/vendors.md).

# Vendors

## Retrieving all vendors

> Retrieves all vendors. You can filter, sort and paginate the results with query parameters.

```json
{"openapi":"3.0.0","info":{"title":"Vendor Service","version":"0.0.1"},"tags":[{"name":"Vendors"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["vendor.vendor_read","vendor.vendor_manage"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.emporix.io/oauth/token","scopes":{"vendor.vendor_read":"Needed to read vendors and locations","vendor.vendor_manage":"Needed to manage vendors and locations"}}}}},"parameters":{"trait_paged_pageNumber":{"name":"pageNumber","in":"query","description":"The page number to be retrieved where the size of the pages must be specified by the pageSize parameter.\nThe number of the first page is 1.\n","schema":{"default":1,"minimum":1,"type":"integer"}},"trait_paged_pageSize":{"name":"pageSize","in":"query","description":"The number of documents being retrieved on the page.\n","schema":{"default":16,"minimum":1,"type":"integer"}},"trait_XTotalCount_header":{"in":"header","name":"X-Total-Count","required":false,"description":"In order to get information how many entities meet a filter requirements, X-Total-Count header has been introduced. The header is optional and its default value is false. If the header is provided and it is true then total count is returned in the X-Total-Count response header.","schema":{"default":false,"type":"boolean"}},"trait_sort":{"in":"query","name":"sort","required":false,"description":"Fields to sort the response data by following order of the parameters from left to right. Can contain multiple fields in format: field name:sort direction separated by a comma. The colon with sort direction parameter is redundant and descending order is taken only if it is equal to desc or DESC. Ascending order is considered in any other case.","schema":{"type":"string"}},"trait_q_param":{"in":"query","name":"q","required":false,"description":"Query param for filtering entities by specified type. Examples of query params which are supported:\n\n| Q Param                                                                            | Description                                                                                                                          |\n|------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| `name:\"Exact match\"`                                                               | find an entity with `name` field with `Exact match` value                                                                            |\n| `name:~Supplier`                                                                   | find an entity with `name` field containing `Supplier` value                                                                        |\n| `type:COMPANY`                                                                     | find an entity with `type` field with `COMPANY` value                                                                               |\n| `metadata.createdAt:(>\"2019-01-06T10:29:30.602Z\" AND <\"2020-01-07T10:29:30.602Z\")` | find an entity with `metadata.createdAt` field with value between `2019-01-06T10:29:30.602Z` and `2020-01-07T10:29:30.602Z`      |\n| `name:exists`                                                                      | find an entity with existing `name` field                                                                                            |\n| `name:null`                                                                        | find an entity with non-existing `name` field                                                                                        |\n","schema":{"type":"string"}},"trait_fields":{"in":"query","name":"fields","required":false,"description":"Comma-separated list of fields to return in the response. If not specified, all fields are returned.","schema":{"type":"string"}},"trait_vendor_id_query_param":{"name":"id","in":"query","required":false,"schema":{"type":"string"},"description":"Vendor id. When specified, only vendor with the specified id will be returned.\n"},"trait_vendor_name_query_param":{"name":"name","in":"query","required":false,"schema":{"type":"string"},"description":"Vendor name. When specified, only vendors containing the specified name will be returned.\n"},"trait_vendor_type_query_param":{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["COMPANY","SUBSIDIARY"]},"description":"Vendor type. When specified, only vendors with the specified type will be returned.\n"},"trait_vendor_parentId_query_param":{"name":"parentId","in":"query","required":false,"schema":{"type":"string"},"description":"The id of the parent vendor. When specified, only vendors with the specified parent will be returned.\n"},"trait_vendor_legalName_query_param":{"name":"legalInfo.legalName","in":"query","required":false,"schema":{"type":"string"},"description":"The legal name of the vendor. When specified, only vendors containing the specified name will be returned.\n"},"trait_vendor_registrationDate_query_param":{"name":"legalInfo.registrationDate","in":"query","required":false,"schema":{"type":"string"},"description":"Vendor registration date. When specified, only vendors registered in the specified date will be returned.\n"},"trait_vendor_countryOfRegistration_query_param":{"name":"legalInfo.countryOfRegistration","in":"query","required":false,"schema":{"type":"string"},"description":"Vendor registration country. When specified, only vendors containing the specified registration country will be returned.\n"},"trait_vendor_taxRegistrationNumber_query_param":{"name":"legalInfo.taxRegistrationNumber","in":"query","required":false,"schema":{"type":"string"},"description":"Vendor tax registration number. When specified, only vendors with the specified tax registration number will be returned.\n"}},"responses":{"GetVendors":{"description":"The request was successful. A list of vendors is returned.","headers":{"X-Total-Count":{"description":"'The total number of entities in the database matching the specified query criteria.\nReturned if the request X-Total-Count header has been set to true.'","schema":{"type":"number"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/vendor"}}}}},"BadRequest_400":{"description":"Request was syntactically incorrect. Details will be provided in the response payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"Unauthorized_401":{"description":"Given request is unauthorized - the authorization token is invalid or has expired.","content":{"application/json":{"schema":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}}},"Forbidden_403":{"description":"Given authorization scopes are not sufficient and do not match scopes required by the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"InternalServiceError_500":{"description":"Internal Service Error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}}},"schemas":{"vendor":{"title":"Vendor","type":"object","properties":{"id":{"type":"string","description":"The vendor unique identifier."},"name":{"type":"string","description":"The name of the vendor."},"type":{"type":"string","enum":["COMPANY","SUBSIDIARY"],"description":"The type of the vendor."},"parentId":{"type":"string","description":"The id of the parent vendor."},"legalInfo":{"$ref":"#/components/schemas/legalInfo"},"contactDetails":{"type":"array","description":"The list of contact details for the vendor.","items":{"$ref":"#/components/schemas/vendorContactDetails"}},"locations":{"type":"array","description":"The list of locations assigned to the vendor.","items":{"$ref":"#/components/schemas/location"}},"metadata":{"$ref":"#/components/schemas/metadata"},"mixins":{"type":"object","description":"Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.","additionalProperties":true}}},"legalInfo":{"title":"Vendor Legal Information","type":"object","properties":{"legalName":{"type":"string","description":"The legal name of the vendor."},"registrationDate":{"type":"string","description":"The registration date of the vendor in the ISO 8601 format."},"countryOfRegistration":{"type":"string","description":"The country in which the vendor has been registered."},"taxRegistrationNumber":{"type":"string","description":"The tax registration number of the vendor."}}},"vendorContactDetails":{"title":"Contact Details","type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"description":"The list of contact emails."},"phones":{"type":"array","items":{"type":"string"},"description":"The list of contact phone numbers."},"addressLine1":{"type":"string","description":"The first address line of the contact."},"city":{"type":"string","description":"The city of the contact."},"state":{"type":"string","description":"The state of the contact."},"postcode":{"type":"string","description":"The post code of the contact."},"countryCode":{"type":"string","description":"The country code of the contact."}},"required":["email"]},"location":{"title":"Location","type":"object","properties":{"id":{"type":"string","description":"The location unique identifier."},"name":{"type":"string","description":"The name of the location."},"type":{"type":"string","enum":["HEADQUARTER","WAREHOUSE","OFFICE"],"description":"The type of the location."},"contactDetails":{"$ref":"#/components/schemas/contactDetails"},"metadata":{"$ref":"#/components/schemas/metadata"},"mixins":{"type":"object","description":"Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.","additionalProperties":true}}},"contactDetails":{"title":"Contact Details","type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"description":"The list of contact emails."},"phones":{"type":"array","items":{"type":"string"},"description":"The list of contact phone numbers."},"addressLine1":{"type":"string","description":"The first address line of the contact."},"city":{"type":"string","description":"The city of the contact."},"state":{"type":"string","description":"The state of the contact."},"postcode":{"type":"string","description":"The post code of the contact."},"countryCode":{"type":"string","description":"The country code of the contact."},"tags":{"type":"array","items":{"type":"string"},"description":"Allows to tag the location."}}},"metadata":{"type":"object","allOf":[{"$ref":"#/components/schemas/metadataUpdate"},{"type":"object","properties":{"createdAt":{"description":"Date and time when the document was created.","type":"string"},"modifiedAt":{"description":"Date and time when the document was last modified.","type":"string"}}}]},"metadataUpdate":{"type":"object","properties":{"version":{"minimum":1,"type":"integer","description":"Version of the document."},"mixins":{"type":"object","description":"Links to the mixin schemas. A map where the keys represent mixins set attributes and the values represent url to a schema for a particular set.","additionalProperties":true}}},"errorMessage":{"title":"Error","description":"Schema for API specified errors.","type":"object","properties":{"code":{"minimum":100,"maximum":599,"description":"Original HTTP error code, should be consistent with the response HTTP code.","type":"integer"},"status":{"description":"Original HTTP error name.","type":"string"},"message":{"description":"Descriptive error message for debugging.","type":"string"},"resourceId":{"type":"string","description":"Id of the resource."},"details":{"description":"List of problems causing this error.","type":"array","items":{"description":"Details for specific error cause.","type":"string"}}},"required":["status","code"]}}},"paths":{"/vendor/{tenant}/vendors":{"get":{"summary":"Retrieving all vendors","description":"Retrieves all vendors. You can filter, sort and paginate the results with query parameters.","parameters":[{"$ref":"#/components/parameters/trait_paged_pageNumber"},{"$ref":"#/components/parameters/trait_paged_pageSize"},{"$ref":"#/components/parameters/trait_XTotalCount_header"},{"$ref":"#/components/parameters/trait_sort"},{"$ref":"#/components/parameters/trait_q_param"},{"$ref":"#/components/parameters/trait_fields"},{"$ref":"#/components/parameters/trait_vendor_id_query_param"},{"$ref":"#/components/parameters/trait_vendor_name_query_param"},{"$ref":"#/components/parameters/trait_vendor_type_query_param"},{"$ref":"#/components/parameters/trait_vendor_parentId_query_param"},{"$ref":"#/components/parameters/trait_vendor_legalName_query_param"},{"$ref":"#/components/parameters/trait_vendor_registrationDate_query_param"},{"$ref":"#/components/parameters/trait_vendor_countryOfRegistration_query_param"},{"$ref":"#/components/parameters/trait_vendor_taxRegistrationNumber_query_param"}],"responses":{"200":{"$ref":"#/components/responses/GetVendors"},"400":{"$ref":"#/components/responses/BadRequest_400"},"401":{"$ref":"#/components/responses/Unauthorized_401"},"403":{"$ref":"#/components/responses/Forbidden_403"},"500":{"$ref":"#/components/responses/InternalServiceError_500"}},"operationId":"GET-vendor-mgmt-list-vendors","tags":["Vendors"]}}}}
```

## Creating a vendor

> Creates a new vendor for the tenant. A vendor represents a supplier or a business partner in the system.

```json
{"openapi":"3.0.0","info":{"title":"Vendor Service","version":"0.0.1"},"tags":[{"name":"Vendors"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["vendor.vendor_manage"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.emporix.io/oauth/token","scopes":{"vendor.vendor_read":"Needed to read vendors and locations","vendor.vendor_manage":"Needed to manage vendors and locations"}}}}},"schemas":{"vendorCreate":{"title":"Vendor create payload","type":"object","properties":{"id":{"type":"string","description":"Custom vendor identifier. If not provided, it is automatically generated.","minLength":1,"maxLength":66,"pattern":"^[a-zA-Z0-9_-]+$"},"name":{"type":"string","description":"The name of the vendor."},"type":{"type":"string","enum":["COMPANY","SUBSIDIARY"],"description":"The type of the vendor. If not provided, the default value is: `COMPANY`."},"parentId":{"type":"string","description":"The ID of the parent vendor."},"legalInfo":{"$ref":"#/components/schemas/legalInfo"},"contactDetails":{"type":"array","description":"The list of contact details for the vendor.","items":{"$ref":"#/components/schemas/vendorContactDetails"}},"locations":{"type":"array","description":"The list of location IDs assigned to the vendor.","items":{"$ref":"#/components/schemas/resourceId"}},"mixins":{"type":"object","description":"Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.","additionalProperties":true}},"required":["name"]},"legalInfo":{"title":"Vendor Legal Information","type":"object","properties":{"legalName":{"type":"string","description":"The legal name of the vendor."},"registrationDate":{"type":"string","description":"The registration date of the vendor in the ISO 8601 format."},"countryOfRegistration":{"type":"string","description":"The country in which the vendor has been registered."},"taxRegistrationNumber":{"type":"string","description":"The tax registration number of the vendor."}}},"vendorContactDetails":{"title":"Contact Details","type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"description":"The list of contact emails."},"phones":{"type":"array","items":{"type":"string"},"description":"The list of contact phone numbers."},"addressLine1":{"type":"string","description":"The first address line of the contact."},"city":{"type":"string","description":"The city of the contact."},"state":{"type":"string","description":"The state of the contact."},"postcode":{"type":"string","description":"The post code of the contact."},"countryCode":{"type":"string","description":"The country code of the contact."}},"required":["email"]},"resourceId":{"title":"Resource","type":"object","properties":{"id":{"type":"string","description":"Id of a resource."}}},"errorMessage":{"title":"Error","description":"Schema for API specified errors.","type":"object","properties":{"code":{"minimum":100,"maximum":599,"description":"Original HTTP error code, should be consistent with the response HTTP code.","type":"integer"},"status":{"description":"Original HTTP error name.","type":"string"},"message":{"description":"Descriptive error message for debugging.","type":"string"},"resourceId":{"type":"string","description":"Id of the resource."},"details":{"description":"List of problems causing this error.","type":"array","items":{"description":"Details for specific error cause.","type":"string"}}},"required":["status","code"]}},"responses":{"BadRequest_400":{"description":"Request was syntactically incorrect. Details will be provided in the response payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"Unauthorized_401":{"description":"Given request is unauthorized - the authorization token is invalid or has expired.","content":{"application/json":{"schema":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}}},"Forbidden_403":{"description":"Given authorization scopes are not sufficient and do not match scopes required by the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"Conflict_409":{"description":"Given resource already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"InternalServiceError_500":{"description":"Internal Service Error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}}}},"paths":{"/vendor/{tenant}/vendors":{"post":{"summary":"Creating a vendor","description":"Creates a new vendor for the tenant. A vendor represents a supplier or a business partner in the system.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vendorCreate"}}}},"responses":{"201":{"description":"The request was successful. The vendor has been created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest_400"},"401":{"$ref":"#/components/responses/Unauthorized_401"},"403":{"$ref":"#/components/responses/Forbidden_403"},"409":{"$ref":"#/components/responses/Conflict_409"},"500":{"$ref":"#/components/responses/InternalServiceError_500"}},"operationId":"POST-vendor-mgmt-create-vendor","tags":["Vendors"]}}}}
```

## Searching with parameters for vendors

> Retrieves all vendors that match the provided criteria.

```json
{"openapi":"3.0.0","info":{"title":"Vendor Service","version":"0.0.1"},"tags":[{"name":"Vendors"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["vendor.vendor_read","vendor.vendor_manage"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.emporix.io/oauth/token","scopes":{"vendor.vendor_read":"Needed to read vendors and locations","vendor.vendor_manage":"Needed to manage vendors and locations"}}}}},"parameters":{"trait_paged_pageNumber":{"name":"pageNumber","in":"query","description":"The page number to be retrieved where the size of the pages must be specified by the pageSize parameter.\nThe number of the first page is 1.\n","schema":{"default":1,"minimum":1,"type":"integer"}},"trait_paged_pageSize":{"name":"pageSize","in":"query","description":"The number of documents being retrieved on the page.\n","schema":{"default":16,"minimum":1,"type":"integer"}},"trait_XTotalCount_header":{"in":"header","name":"X-Total-Count","required":false,"description":"In order to get information how many entities meet a filter requirements, X-Total-Count header has been introduced. The header is optional and its default value is false. If the header is provided and it is true then total count is returned in the X-Total-Count response header.","schema":{"default":false,"type":"boolean"}},"trait_sort":{"in":"query","name":"sort","required":false,"description":"Fields to sort the response data by following order of the parameters from left to right. Can contain multiple fields in format: field name:sort direction separated by a comma. The colon with sort direction parameter is redundant and descending order is taken only if it is equal to desc or DESC. Ascending order is considered in any other case.","schema":{"type":"string"}},"trait_fields":{"in":"query","name":"fields","required":false,"description":"Comma-separated list of fields to return in the response. If not specified, all fields are returned.","schema":{"type":"string"}},"trait_vendor_id_query_param":{"name":"id","in":"query","required":false,"schema":{"type":"string"},"description":"Vendor id. When specified, only vendor with the specified id will be returned.\n"},"trait_vendor_name_query_param":{"name":"name","in":"query","required":false,"schema":{"type":"string"},"description":"Vendor name. When specified, only vendors containing the specified name will be returned.\n"},"trait_vendor_type_query_param":{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["COMPANY","SUBSIDIARY"]},"description":"Vendor type. When specified, only vendors with the specified type will be returned.\n"},"trait_vendor_parentId_query_param":{"name":"parentId","in":"query","required":false,"schema":{"type":"string"},"description":"The id of the parent vendor. When specified, only vendors with the specified parent will be returned.\n"},"trait_vendor_legalName_query_param":{"name":"legalInfo.legalName","in":"query","required":false,"schema":{"type":"string"},"description":"The legal name of the vendor. When specified, only vendors containing the specified name will be returned.\n"},"trait_vendor_registrationDate_query_param":{"name":"legalInfo.registrationDate","in":"query","required":false,"schema":{"type":"string"},"description":"Vendor registration date. When specified, only vendors registered in the specified date will be returned.\n"},"trait_vendor_countryOfRegistration_query_param":{"name":"legalInfo.countryOfRegistration","in":"query","required":false,"schema":{"type":"string"},"description":"Vendor registration country. When specified, only vendors containing the specified registration country will be returned.\n"},"trait_vendor_taxRegistrationNumber_query_param":{"name":"legalInfo.taxRegistrationNumber","in":"query","required":false,"schema":{"type":"string"},"description":"Vendor tax registration number. When specified, only vendors with the specified tax registration number will be returned.\n"}},"responses":{"GetVendors":{"description":"The request was successful. A list of vendors is returned.","headers":{"X-Total-Count":{"description":"'The total number of entities in the database matching the specified query criteria.\nReturned if the request X-Total-Count header has been set to true.'","schema":{"type":"number"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/vendor"}}}}},"BadRequest_400":{"description":"Request was syntactically incorrect. Details will be provided in the response payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"Unauthorized_401":{"description":"Given request is unauthorized - the authorization token is invalid or has expired.","content":{"application/json":{"schema":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}}},"Forbidden_403":{"description":"Given authorization scopes are not sufficient and do not match scopes required by the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"InternalServiceError_500":{"description":"Internal Service Error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}}},"schemas":{"vendor":{"title":"Vendor","type":"object","properties":{"id":{"type":"string","description":"The vendor unique identifier."},"name":{"type":"string","description":"The name of the vendor."},"type":{"type":"string","enum":["COMPANY","SUBSIDIARY"],"description":"The type of the vendor."},"parentId":{"type":"string","description":"The id of the parent vendor."},"legalInfo":{"$ref":"#/components/schemas/legalInfo"},"contactDetails":{"type":"array","description":"The list of contact details for the vendor.","items":{"$ref":"#/components/schemas/vendorContactDetails"}},"locations":{"type":"array","description":"The list of locations assigned to the vendor.","items":{"$ref":"#/components/schemas/location"}},"metadata":{"$ref":"#/components/schemas/metadata"},"mixins":{"type":"object","description":"Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.","additionalProperties":true}}},"legalInfo":{"title":"Vendor Legal Information","type":"object","properties":{"legalName":{"type":"string","description":"The legal name of the vendor."},"registrationDate":{"type":"string","description":"The registration date of the vendor in the ISO 8601 format."},"countryOfRegistration":{"type":"string","description":"The country in which the vendor has been registered."},"taxRegistrationNumber":{"type":"string","description":"The tax registration number of the vendor."}}},"vendorContactDetails":{"title":"Contact Details","type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"description":"The list of contact emails."},"phones":{"type":"array","items":{"type":"string"},"description":"The list of contact phone numbers."},"addressLine1":{"type":"string","description":"The first address line of the contact."},"city":{"type":"string","description":"The city of the contact."},"state":{"type":"string","description":"The state of the contact."},"postcode":{"type":"string","description":"The post code of the contact."},"countryCode":{"type":"string","description":"The country code of the contact."}},"required":["email"]},"location":{"title":"Location","type":"object","properties":{"id":{"type":"string","description":"The location unique identifier."},"name":{"type":"string","description":"The name of the location."},"type":{"type":"string","enum":["HEADQUARTER","WAREHOUSE","OFFICE"],"description":"The type of the location."},"contactDetails":{"$ref":"#/components/schemas/contactDetails"},"metadata":{"$ref":"#/components/schemas/metadata"},"mixins":{"type":"object","description":"Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.","additionalProperties":true}}},"contactDetails":{"title":"Contact Details","type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"description":"The list of contact emails."},"phones":{"type":"array","items":{"type":"string"},"description":"The list of contact phone numbers."},"addressLine1":{"type":"string","description":"The first address line of the contact."},"city":{"type":"string","description":"The city of the contact."},"state":{"type":"string","description":"The state of the contact."},"postcode":{"type":"string","description":"The post code of the contact."},"countryCode":{"type":"string","description":"The country code of the contact."},"tags":{"type":"array","items":{"type":"string"},"description":"Allows to tag the location."}}},"metadata":{"type":"object","allOf":[{"$ref":"#/components/schemas/metadataUpdate"},{"type":"object","properties":{"createdAt":{"description":"Date and time when the document was created.","type":"string"},"modifiedAt":{"description":"Date and time when the document was last modified.","type":"string"}}}]},"metadataUpdate":{"type":"object","properties":{"version":{"minimum":1,"type":"integer","description":"Version of the document."},"mixins":{"type":"object","description":"Links to the mixin schemas. A map where the keys represent mixins set attributes and the values represent url to a schema for a particular set.","additionalProperties":true}}},"errorMessage":{"title":"Error","description":"Schema for API specified errors.","type":"object","properties":{"code":{"minimum":100,"maximum":599,"description":"Original HTTP error code, should be consistent with the response HTTP code.","type":"integer"},"status":{"description":"Original HTTP error name.","type":"string"},"message":{"description":"Descriptive error message for debugging.","type":"string"},"resourceId":{"type":"string","description":"Id of the resource."},"details":{"description":"List of problems causing this error.","type":"array","items":{"description":"Details for specific error cause.","type":"string"}}},"required":["status","code"]}}},"paths":{"/vendor/{tenant}/vendors/search":{"post":{"summary":"Searching with parameters for vendors","description":"Retrieves all vendors that match the provided criteria.","parameters":[{"$ref":"#/components/parameters/trait_paged_pageNumber"},{"$ref":"#/components/parameters/trait_paged_pageSize"},{"$ref":"#/components/parameters/trait_XTotalCount_header"},{"$ref":"#/components/parameters/trait_sort"},{"$ref":"#/components/parameters/trait_fields"},{"$ref":"#/components/parameters/trait_vendor_id_query_param"},{"$ref":"#/components/parameters/trait_vendor_name_query_param"},{"$ref":"#/components/parameters/trait_vendor_type_query_param"},{"$ref":"#/components/parameters/trait_vendor_parentId_query_param"},{"$ref":"#/components/parameters/trait_vendor_legalName_query_param"},{"$ref":"#/components/parameters/trait_vendor_registrationDate_query_param"},{"$ref":"#/components/parameters/trait_vendor_countryOfRegistration_query_param"},{"$ref":"#/components/parameters/trait_vendor_taxRegistrationNumber_query_param"}],"requestBody":{"content":{"application/json":{"schema":{"title":"qParam","type":"object","properties":{"q":{"type":"string","description":"Query param for filtering entities by specified type."}}}}}},"responses":{"200":{"$ref":"#/components/responses/GetVendors"},"400":{"$ref":"#/components/responses/BadRequest_400"},"401":{"$ref":"#/components/responses/Unauthorized_401"},"403":{"$ref":"#/components/responses/Forbidden_403"},"500":{"$ref":"#/components/responses/InternalServiceError_500"}},"operationId":"POST-vendor-mgmt-search-vendors","tags":["Vendors"]}}}}
```

## Retrieving a vendor

> Retrieves a vendor by the specified unique identifier.

```json
{"openapi":"3.0.0","info":{"title":"Vendor Service","version":"0.0.1"},"tags":[{"name":"Vendors"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["vendor.vendor_read","vendor.vendor_manage"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.emporix.io/oauth/token","scopes":{"vendor.vendor_read":"Needed to read vendors and locations","vendor.vendor_manage":"Needed to manage vendors and locations"}}}}},"parameters":{"trait_fields":{"in":"query","name":"fields","required":false,"description":"Comma-separated list of fields to return in the response. If not specified, all fields are returned.","schema":{"type":"string"}}},"responses":{"GetVendor":{"description":"The request was successful. The requested vendor is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vendor"}}}},"BadRequest_400":{"description":"Request was syntactically incorrect. Details will be provided in the response payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"Unauthorized_401":{"description":"Given request is unauthorized - the authorization token is invalid or has expired.","content":{"application/json":{"schema":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}}},"Forbidden_403":{"description":"Given authorization scopes are not sufficient and do not match scopes required by the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"NotFound_404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"InternalServiceError_500":{"description":"Internal Service Error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}}},"schemas":{"vendor":{"title":"Vendor","type":"object","properties":{"id":{"type":"string","description":"The vendor unique identifier."},"name":{"type":"string","description":"The name of the vendor."},"type":{"type":"string","enum":["COMPANY","SUBSIDIARY"],"description":"The type of the vendor."},"parentId":{"type":"string","description":"The id of the parent vendor."},"legalInfo":{"$ref":"#/components/schemas/legalInfo"},"contactDetails":{"type":"array","description":"The list of contact details for the vendor.","items":{"$ref":"#/components/schemas/vendorContactDetails"}},"locations":{"type":"array","description":"The list of locations assigned to the vendor.","items":{"$ref":"#/components/schemas/location"}},"metadata":{"$ref":"#/components/schemas/metadata"},"mixins":{"type":"object","description":"Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.","additionalProperties":true}}},"legalInfo":{"title":"Vendor Legal Information","type":"object","properties":{"legalName":{"type":"string","description":"The legal name of the vendor."},"registrationDate":{"type":"string","description":"The registration date of the vendor in the ISO 8601 format."},"countryOfRegistration":{"type":"string","description":"The country in which the vendor has been registered."},"taxRegistrationNumber":{"type":"string","description":"The tax registration number of the vendor."}}},"vendorContactDetails":{"title":"Contact Details","type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"description":"The list of contact emails."},"phones":{"type":"array","items":{"type":"string"},"description":"The list of contact phone numbers."},"addressLine1":{"type":"string","description":"The first address line of the contact."},"city":{"type":"string","description":"The city of the contact."},"state":{"type":"string","description":"The state of the contact."},"postcode":{"type":"string","description":"The post code of the contact."},"countryCode":{"type":"string","description":"The country code of the contact."}},"required":["email"]},"location":{"title":"Location","type":"object","properties":{"id":{"type":"string","description":"The location unique identifier."},"name":{"type":"string","description":"The name of the location."},"type":{"type":"string","enum":["HEADQUARTER","WAREHOUSE","OFFICE"],"description":"The type of the location."},"contactDetails":{"$ref":"#/components/schemas/contactDetails"},"metadata":{"$ref":"#/components/schemas/metadata"},"mixins":{"type":"object","description":"Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.","additionalProperties":true}}},"contactDetails":{"title":"Contact Details","type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"description":"The list of contact emails."},"phones":{"type":"array","items":{"type":"string"},"description":"The list of contact phone numbers."},"addressLine1":{"type":"string","description":"The first address line of the contact."},"city":{"type":"string","description":"The city of the contact."},"state":{"type":"string","description":"The state of the contact."},"postcode":{"type":"string","description":"The post code of the contact."},"countryCode":{"type":"string","description":"The country code of the contact."},"tags":{"type":"array","items":{"type":"string"},"description":"Allows to tag the location."}}},"metadata":{"type":"object","allOf":[{"$ref":"#/components/schemas/metadataUpdate"},{"type":"object","properties":{"createdAt":{"description":"Date and time when the document was created.","type":"string"},"modifiedAt":{"description":"Date and time when the document was last modified.","type":"string"}}}]},"metadataUpdate":{"type":"object","properties":{"version":{"minimum":1,"type":"integer","description":"Version of the document."},"mixins":{"type":"object","description":"Links to the mixin schemas. A map where the keys represent mixins set attributes and the values represent url to a schema for a particular set.","additionalProperties":true}}},"errorMessage":{"title":"Error","description":"Schema for API specified errors.","type":"object","properties":{"code":{"minimum":100,"maximum":599,"description":"Original HTTP error code, should be consistent with the response HTTP code.","type":"integer"},"status":{"description":"Original HTTP error name.","type":"string"},"message":{"description":"Descriptive error message for debugging.","type":"string"},"resourceId":{"type":"string","description":"Id of the resource."},"details":{"description":"List of problems causing this error.","type":"array","items":{"description":"Details for specific error cause.","type":"string"}}},"required":["status","code"]}}},"paths":{"/vendor/{tenant}/vendors/{vendorId}":{"get":{"summary":"Retrieving a vendor","parameters":[{"$ref":"#/components/parameters/trait_fields"}],"description":"Retrieves a vendor by the specified unique identifier.","responses":{"200":{"$ref":"#/components/responses/GetVendor"},"400":{"$ref":"#/components/responses/BadRequest_400"},"401":{"$ref":"#/components/responses/Unauthorized_401"},"403":{"$ref":"#/components/responses/Forbidden_403"},"404":{"$ref":"#/components/responses/NotFound_404"},"500":{"$ref":"#/components/responses/InternalServiceError_500"}},"operationId":"GET-vendor-mgmt-retrieve-vendor","tags":["Vendors"]}}}}
```

## Upserting a vendor

> Updates or creates a vendor with a given vendor ID. You can omit the \`metadata.version\`, but then optimistic locking is not enabled.

```json
{"openapi":"3.0.0","info":{"title":"Vendor Service","version":"0.0.1"},"tags":[{"name":"Vendors"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["vendor.vendor_manage"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.emporix.io/oauth/token","scopes":{"vendor.vendor_read":"Needed to read vendors and locations","vendor.vendor_manage":"Needed to manage vendors and locations"}}}}},"schemas":{"vendorUpdate":{"title":"Vendor update payload","type":"object","properties":{"name":{"type":"string","description":"The name of the vendor."},"type":{"type":"string","enum":["COMPANY","SUBSIDIARY"],"description":"The type of the vendor."},"parentId":{"type":"string","description":"The ID of the parent vendor."},"legalInfo":{"$ref":"#/components/schemas/legalInfo"},"contactDetails":{"type":"array","description":"The list of contact details for the vendor.","items":{"$ref":"#/components/schemas/vendorContactDetails"}},"locations":{"type":"array","description":"The list of location IDs assigned to the vendor.","items":{"$ref":"#/components/schemas/resourceId"}},"metadata":{"$ref":"#/components/schemas/metadataUpdate"},"mixins":{"type":"object","description":"Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.","additionalProperties":true}},"required":["name","type"]},"legalInfo":{"title":"Vendor Legal Information","type":"object","properties":{"legalName":{"type":"string","description":"The legal name of the vendor."},"registrationDate":{"type":"string","description":"The registration date of the vendor in the ISO 8601 format."},"countryOfRegistration":{"type":"string","description":"The country in which the vendor has been registered."},"taxRegistrationNumber":{"type":"string","description":"The tax registration number of the vendor."}}},"vendorContactDetails":{"title":"Contact Details","type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"description":"The list of contact emails."},"phones":{"type":"array","items":{"type":"string"},"description":"The list of contact phone numbers."},"addressLine1":{"type":"string","description":"The first address line of the contact."},"city":{"type":"string","description":"The city of the contact."},"state":{"type":"string","description":"The state of the contact."},"postcode":{"type":"string","description":"The post code of the contact."},"countryCode":{"type":"string","description":"The country code of the contact."}},"required":["email"]},"resourceId":{"title":"Resource","type":"object","properties":{"id":{"type":"string","description":"Id of a resource."}}},"metadataUpdate":{"type":"object","properties":{"version":{"minimum":1,"type":"integer","description":"Version of the document."},"mixins":{"type":"object","description":"Links to the mixin schemas. A map where the keys represent mixins set attributes and the values represent url to a schema for a particular set.","additionalProperties":true}}},"errorMessage":{"title":"Error","description":"Schema for API specified errors.","type":"object","properties":{"code":{"minimum":100,"maximum":599,"description":"Original HTTP error code, should be consistent with the response HTTP code.","type":"integer"},"status":{"description":"Original HTTP error name.","type":"string"},"message":{"description":"Descriptive error message for debugging.","type":"string"},"resourceId":{"type":"string","description":"Id of the resource."},"details":{"description":"List of problems causing this error.","type":"array","items":{"description":"Details for specific error cause.","type":"string"}}},"required":["status","code"]}},"responses":{"BadRequest_400_Update":{"description":"Request was syntactically incorrect. Details will be provided in the response payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"Unauthorized_401":{"description":"Given request is unauthorized - the authorization token is invalid or has expired.","content":{"application/json":{"schema":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}}},"Forbidden_403":{"description":"Given authorization scopes are not sufficient and do not match scopes required by the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"NotFound_404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"Conflict_409":{"description":"Given resource already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"InternalServiceError_500":{"description":"Internal Service Error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}}}},"paths":{"/vendor/{tenant}/vendors/{vendorId}":{"put":{"summary":"Upserting a vendor","description":"Updates or creates a vendor with a given vendor ID. You can omit the `metadata.version`, but then optimistic locking is not enabled.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vendorUpdate"}}}},"responses":{"201":{"description":"The request was successful. The vendor has been created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}}}}},"204":{"description":"The vendor has been updated successfully."},"400":{"$ref":"#/components/responses/BadRequest_400_Update"},"401":{"$ref":"#/components/responses/Unauthorized_401"},"403":{"$ref":"#/components/responses/Forbidden_403"},"404":{"$ref":"#/components/responses/NotFound_404"},"409":{"$ref":"#/components/responses/Conflict_409"},"500":{"$ref":"#/components/responses/InternalServiceError_500"}},"operationId":"PUT-vendor-mgmt-update-vendor","tags":["Vendors"]}}}}
```

## Delete a vendor

> Deletes a vendor.

```json
{"openapi":"3.0.0","info":{"title":"Vendor Service","version":"0.0.1"},"tags":[{"name":"Vendors"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["vendor.vendor_manage"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.emporix.io/oauth/token","scopes":{"vendor.vendor_read":"Needed to read vendors and locations","vendor.vendor_manage":"Needed to manage vendors and locations"}}}}},"responses":{"BadRequest_400_Update":{"description":"Request was syntactically incorrect. Details will be provided in the response payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"Unauthorized_401":{"description":"Given request is unauthorized - the authorization token is invalid or has expired.","content":{"application/json":{"schema":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}}},"Forbidden_403":{"description":"Given authorization scopes are not sufficient and do not match scopes required by the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"NotFound_404":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}},"InternalServiceError_500":{"description":"Internal Service Error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorMessage"}}}}},"schemas":{"errorMessage":{"title":"Error","description":"Schema for API specified errors.","type":"object","properties":{"code":{"minimum":100,"maximum":599,"description":"Original HTTP error code, should be consistent with the response HTTP code.","type":"integer"},"status":{"description":"Original HTTP error name.","type":"string"},"message":{"description":"Descriptive error message for debugging.","type":"string"},"resourceId":{"type":"string","description":"Id of the resource."},"details":{"description":"List of problems causing this error.","type":"array","items":{"description":"Details for specific error cause.","type":"string"}}},"required":["status","code"]}}},"paths":{"/vendor/{tenant}/vendors/{vendorId}":{"delete":{"summary":"Delete a vendor","description":"Deletes a vendor.","responses":{"204":{"description":"The vendor has been deleted successfully."},"400":{"$ref":"#/components/responses/BadRequest_400_Update"},"401":{"$ref":"#/components/responses/Unauthorized_401"},"403":{"$ref":"#/components/responses/Forbidden_403"},"404":{"$ref":"#/components/responses/NotFound_404"},"500":{"$ref":"#/components/responses/InternalServiceError_500"}},"operationId":"DELETE-vendor-mgmt-remove-vendor","tags":["Vendors"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.emporix.io/api-references-1/readme/api-reference-40/vendors.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.