Procurement | Order

post

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.

Body

application/json

Represents a request payload for creating an order, which includes details such as items to be ordered, a custom reference, and additional notes.

notestring · nullableOptional

Gets or sets additional details or comments associated with the order request. This allows including specific instructions or contextual information relevant to the order.

customOrderReferencestring · max: 100 · nullableOptional

Gets or sets the custom reference identifier for the order. This property can be used to provide a unique, user-defined reference for tracking or associating the order with an external system.

Responses

400

Bad Request

application/json

errorCodestring · nullableOptional

errorDescriptionstring · nullableOptional

dataany · nullableOptional

401

Unauthorized

application/json

403

Forbidden

application/json

post/v1/procurement/purchase-orders

HTTPcURLJavaScriptPython

POST /v1/procurement/purchase-orders HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "requestItems": [
    {
      "requestReferenceId": 1,
      "note": "text"
    }
  ],
  "note": "text",
  "customOrderReference": "text"
}

{
  "errorCode": "text",
  "errorDescription": "text",
  "data": null
}