Sourcing | Suppliers

Retrieve a list of suppliers of the requesting user's organization

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 · enumOptionalPossible values:

sortOrderstring · enumOptional

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

Possible values:

offsetinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 100

Responses

200

OK: List of suppliers.

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/suppliers

HTTPcURLJavaScriptPython

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

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "companyAddress": {
        "line1": "equipme GmbH",
        "street": "W 55th St",
        "number": 240,
        "addition": "3rd floor",
        "city": "New York",
        "postalCode": 10019,
        "countryCode": "US",
        "regionCode": "NY",
        "regionName": "New York",
        "dependentLocality": "Chilmington Green",
        "phoneNumber": "[phone]",
        "id": 83,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "contactName": "John Doe",
      "contactEmail": "[e-mail]",
      "contactPhone": "[phone]",
      "customerNumber": "C00001",
      "note": "Preferred supplier for IT hardware. Long-term partner since 2018.",
      "website": "https://foo.inc",
      "id": 4,
      "name": "foo Inc.",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single supplier 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

supplierIdinteger · int64Required

The identifier of the supplier.

Responses

200

OK: The requested supplier.

application/json

contactNamestring · nullableOptional

The name of the contact person at the supplier.

Example: John Doe

contactEmailstring · nullableOptional

The email address of the contact person at the supplier.

Example: [e-mail]

contactPhonestring · nullableOptional

The phone number of the contact person at the supplier.

Example: [phone]

customerNumberstring · nullableOptional

Own customer number at the supplier.

Example: C00001

notestring · nullableOptional

A note for the supplier.

Example: Preferred supplier for IT hardware. Long-term partner since 2018.

websitestring · nullableOptional

The website of the supplier.

Example: https://foo.inc

idinteger · int64Required

The identifier of the supplier.

Example: 4

namestring · nullableOptional

The name of the supplier.

Example: foo Inc.

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

404

NotFound: Requested resource could not be found.

application/json

get/v1/sourcing/suppliers/{supplierId}

HTTPcURLJavaScriptPython

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

{
  "companyAddress": {
    "line1": "equipme GmbH",
    "street": "W 55th St",
    "number": 240,
    "addition": "3rd floor",
    "city": "New York",
    "postalCode": 10019,
    "countryCode": "US",
    "regionCode": "NY",
    "regionName": "New York",
    "dependentLocality": "Chilmington Green",
    "phoneNumber": "[phone]",
    "id": 83,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "contactName": "John Doe",
  "contactEmail": "[e-mail]",
  "contactPhone": "[phone]",
  "customerNumber": "C00001",
  "note": "Preferred supplier for IT hardware. Long-term partner since 2018.",
  "website": "https://foo.inc",
  "id": 4,
  "name": "foo Inc.",
  "self": {
    "href": "text",
    "method": "text"
  }
}