Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Procurement | Requests

Retrieve a list of procurement requests.

get
Authorizations
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
createdAfterstring · date-timeOptional

Filter the requests created after the specified date.

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 procurement requests.

application/json
totalinteger · int32Required
get/v1/procurement/requests
GET /v1/procurement/requests HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "created": "2026-01-01T00:00:00.000Z",
      "requestedBy": {
        "id": 1,
        "firstName": "Pierce",
        "lastName": "Bell",
        "fullName": "text",
        "email": "p.bell@foo.io",
        "username": "j.doe@foo.inc",
        "costCenter": "4645-2343",
        "costCenterId": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "assignedLocation": {
        "id": 1,
        "name": "HQ New York",
        "type": "location",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "assignedGroup": {
        "id": 42,
        "name": "Project 1337",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "assignedEmployee": {
        "id": 1,
        "firstName": "Pierce",
        "lastName": "Bell",
        "fullName": "text",
        "email": "p.bell@foo.io",
        "username": "j.doe@foo.inc",
        "costCenter": "4645-2343",
        "costCenterId": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "totalOneTimeCosts": 12.98,
      "totalRecurringCosts": 1109.9,
      "subscriptionPeriod": 12,
      "subscriptionPeriodRenewal": 1,
      "items": [
        {
          "type": "service",
          "action": "delivery",
          "service": {
            "id": 4,
            "name": "Basic Plan",
            "category": "text",
            "ean": "0194253408253",
            "externalId": "E54363",
            "supplierName": "text",
            "previewImageLink": "text",
            "type": "service",
            "self": {
              "href": "text",
              "method": "text"
            }
          },
          "options": [
            {
              "id": 1,
              "name": "text",
              "versionId": 1,
              "versionName": "text",
              "action": "delivery",
              "offer": {
                "id": 99,
                "type": "rental",
                "purchasePrice": 99.99,
                "recurringPrice": 19.99,
                "subscriptionPeriod": 12,
                "self": {
                  "href": "text",
                  "method": "text"
                }
              },
              "versions": [
                {
                  "id": 1,
                  "versionName": "text",
                  "purchasePrice": 1,
                  "recurringPrice": 1
                }
              ],
              "self": {
                "href": "text",
                "method": "text"
              }
            }
          ],
          "offer": {
            "id": 99,
            "type": "rental",
            "purchasePrice": 99.99,
            "recurringPrice": 19.99,
            "subscriptionPeriod": 12,
            "self": {
              "href": "text",
              "method": "text"
            }
          },
          "targetInstance": {
            "id": 42,
            "inventoryNumber": "EQ642",
            "costCenter": "4645-2343",
            "self": {
              "href": "text",
              "method": "text"
            }
          },
          "cartTargetInstanceId": 1,
          "note": "This is just a <b>custom note</b>.",
          "preferredProvisionDate": "2026-01-01T00:00:00.000Z"
        }
      ],
      "approved": true,
      "justification": "text",
      "deliveryAddress": "text",
      "costCenterCode": "text",
      "costCenterId": 1,
      "id": 451,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Adds items (procurement requests) to the cart (approvals) for a given tenant.

post
Authorizations
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.

Body
Responses
400

Bad Request

application/json
errorCodestring · nullableOptional
errorDescriptionstring · nullableOptional
dataany · nullableOptional
post/v1/procurement/requests
POST /v1/procurement/requests HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 502

{
  "items": [
    {
      "requestAction": "delivery",
      "requestedBy": 1,
      "locationAssignment": 1,
      "employeeAssignment": 1,
      "organizationalUnitAssignment": 1,
      "productOfferId": 1,
      "requestedDeliveryDate": "2026-01-01T00:00:00.000Z",
      "deviatingDeliveryAddress": {
        "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": "+1 212-555-1234"
      },
      "note": "text"
    }
  ]
}
{
  "errorCode": "text",
  "errorDescription": "text",
  "data": null
}
get
Authorizations
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
requestIdinteger · int32Required
Query parameters
includeAllOptionVersionsbooleanOptionalDefault: false
Responses
200

OK

application/json
totalinteger · int32Required
get/v1/procurement/requests/{requestId}
GET /v1/procurement/requests/{requestId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "created": "2026-01-01T00:00:00.000Z",
      "requestedBy": {
        "id": 1,
        "firstName": "Pierce",
        "lastName": "Bell",
        "fullName": "text",
        "email": "p.bell@foo.io",
        "username": "j.doe@foo.inc",
        "costCenter": "4645-2343",
        "costCenterId": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "assignedLocation": {
        "id": 1,
        "name": "HQ New York",
        "type": "location",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "assignedGroup": {
        "id": 42,
        "name": "Project 1337",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "assignedEmployee": {
        "id": 1,
        "firstName": "Pierce",
        "lastName": "Bell",
        "fullName": "text",
        "email": "p.bell@foo.io",
        "username": "j.doe@foo.inc",
        "costCenter": "4645-2343",
        "costCenterId": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "totalOneTimeCosts": 12.98,
      "totalRecurringCosts": 1109.9,
      "subscriptionPeriod": 12,
      "subscriptionPeriodRenewal": 1,
      "items": [
        {
          "type": "service",
          "action": "delivery",
          "service": {
            "id": 4,
            "name": "Basic Plan",
            "category": "text",
            "ean": "0194253408253",
            "externalId": "E54363",
            "supplierName": "text",
            "previewImageLink": "text",
            "type": "service",
            "self": {
              "href": "text",
              "method": "text"
            }
          },
          "options": [
            {
              "id": 1,
              "name": "text",
              "versionId": 1,
              "versionName": "text",
              "action": "delivery",
              "offer": {
                "id": 99,
                "type": "rental",
                "purchasePrice": 99.99,
                "recurringPrice": 19.99,
                "subscriptionPeriod": 12,
                "self": {
                  "href": "text",
                  "method": "text"
                }
              },
              "versions": [
                {
                  "id": 1,
                  "versionName": "text",
                  "purchasePrice": 1,
                  "recurringPrice": 1
                }
              ],
              "self": {
                "href": "text",
                "method": "text"
              }
            }
          ],
          "offer": {
            "id": 99,
            "type": "rental",
            "purchasePrice": 99.99,
            "recurringPrice": 19.99,
            "subscriptionPeriod": 12,
            "self": {
              "href": "text",
              "method": "text"
            }
          },
          "targetInstance": {
            "id": 42,
            "inventoryNumber": "EQ642",
            "costCenter": "4645-2343",
            "self": {
              "href": "text",
              "method": "text"
            }
          },
          "cartTargetInstanceId": 1,
          "note": "This is just a <b>custom note</b>.",
          "preferredProvisionDate": "2026-01-01T00:00:00.000Z"
        }
      ],
      "approved": true,
      "justification": "text",
      "deliveryAddress": "text",
      "costCenterCode": "text",
      "costCenterId": 1,
      "id": 451,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Deletes a cart item with the specified identifier.

delete
Authorizations
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
requestIdinteger · int32Required

The unique identifier of the cart item to be deleted.

Query parameters
reasonstringOptional

Optional free-text reason recorded on the underlying approval request's history (e.g. when deletion is caused by a swap).

Responses
200

OK

application/json
statusCodeinteger · int32Optional
delete/v1/procurement/requests/{requestId}
DELETE /v1/procurement/requests/{requestId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "statusCode": 1
}

Updates the details of a specific item in the user's cart.

patch
Authorizations
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
requestIdinteger · int32Required
Body
Responses
400

Bad Request

application/json
errorCodestring · nullableOptional
errorDescriptionstring · nullableOptional
dataany · nullableOptional
patch/v1/procurement/requests/{requestId}
PATCH /v1/procurement/requests/{requestId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "patchDocument": {
    "operations": [
      {
        "value": null,
        "path": "text",
        "op": "text",
        "from": "text"
      }
    ]
  }
}
{
  "errorCode": "text",
  "errorDescription": "text",
  "data": null
}

Last updated

Was this helpful?