Procurement | Products

Retrieve a list of products.

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 items 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 item to return

Default: 0

limitinteger · int32Optional

Specifies the maximum number of items to return (min: 1; max: 1000)

Default: 100

Responses

200

OK: Returns a list of products.

application/json

totalinteger · int32Required

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

get/v1/procurement/products

HTTPcURLJavaScriptPython

GET /v1/procurement/products HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "description": "Best notebook for starters.",
      "configurationType": "simple",
      "previewImage": "text",
      "attributes": [
        {
          "definition": {
            "id": 4,
            "name": "RAM",
            "self": {
              "href": "text",
              "method": "text"
            }
          },
          "value": {
            "id": 4,
            "displayValue": "8 GB",
            "self": {
              "href": "text",
              "method": "text"
            }
          },
          "rank": 1
        }
      ],
      "offers": [
        {
          "type": "rental",
          "currency": "EUR",
          "purchasePrice": 39.9,
          "recurringPrice": 1.99,
          "subscriptionPeriod": 12,
          "id": 3991,
          "self": {
            "href": "text",
            "method": "text"
          }
        }
      ],
      "id": 12661,
      "name": "Notebook Pro",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

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

productIdinteger · int32Required

The identifier of the product.

Responses

200

OK: The requested product.

application/json

descriptionstring · nullableOptional

A short description of the product.

Example: Best notebook for starters.

configurationTypestring · enumOptional

Defines the configuration complexity of a service. Can not be changed after service creation.

Possible values:

previewImagestring · nullableOptional

A link to the preview image of the product.

idinteger · int32Required

The identifier of the product.

Example: 12661

namestring · min: 1Required

The name of the product.

Example: Notebook Pro

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/procurement/products/{productId}

HTTPcURLJavaScriptPython

GET /v1/procurement/products/{productId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "description": "Best notebook for starters.",
  "configurationType": "simple",
  "previewImage": "text",
  "attributes": [
    {
      "definition": {
        "id": 4,
        "name": "RAM",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "value": {
        "id": 4,
        "displayValue": "8 GB",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "rank": 1
    }
  ],
  "offers": [
    {
      "type": "rental",
      "currency": "EUR",
      "purchasePrice": 39.9,
      "recurringPrice": 1.99,
      "subscriptionPeriod": 12,
      "id": 3991,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "id": 12661,
  "name": "Notebook Pro",
  "self": {
    "href": "text",
    "method": "text"
  }
}