Sourcing | Manufacturers

Retrieve a list of manufacturers

get

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Query parameters

sortBystring · enumOptional

Sort the manufacturers by a given criterion

Possible values:

sortOrderstring · enumOptional

Order in which the result of a list request is sorted.

Possible values:

offsetinteger · int32Optional

Specifies the index of the first manufacturer to return

Default: 0

limitinteger · int32Optional

Specifies the maximum number of manufacturers to return

Default: 100

Responses

200

OK: List of manufacturers.

application/json

totalinteger · int32Required

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

get/v1/sourcing/manufacturers

HTTPcURLJavaScriptPython

GET /v1/sourcing/manufacturers HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "note": "Basic Plan",
      "id": 1,
      "name": "equipme GmbH",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single manufacturer by its id.

get

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

manufacturerIdinteger · int64Required

The identifier of the manufacturer.

Responses

200

OK: The requested manufacturer.

application/json

notestring · max: 1023 · nullableOptional

A note for the manufacturer

Example: Basic Plan

idinteger · int64Required

The identifier of the manufacturer.

Example: 1

namestring · min: 1Required

The name of the manufacturer

Example: equipme GmbH

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

get/v1/sourcing/manufacturers/{manufacturerId}

HTTPcURLJavaScriptPython

GET /v1/sourcing/manufacturers/{manufacturerId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "note": "Basic Plan",
  "id": 1,
  "name": "equipme GmbH",
  "self": {
    "href": "text",
    "method": "text"
  }
}