Reservation APIs

Create Reservation

post

https://sandbox.onepint.ai/services/inventoryhttps://prod.onepint.ai/services/inventory

/demand/v1/process-reservations

Creates a reservation for the given item ID, tenant, reference ID and other parameters. Reservations can be created as either soft reservations or hard reservations based on the Expiry Window property.

Authorizations

api_keybearer-jwt

X-API-KeystringRequired

To access any of the APIs unless mentioned otherwise will need API Key input for authentication purpose. To get your API Key, please get in touch with OnePint team.

Body

application/json

orderTypestringOptional

Specifies the type of an order.

Example: SalesOrder

orderNumberstringOptional

Specifies the number for an order.

Example: orderNumber02111902-02

referenceIdstringOptional

Specifies the reference identifier of the demand.

Example: 02111902-02

reservationIdstringOptional

Specifies the reservation identifier of the demand.

Example: 02111902-02

actionstringOptional

Specifies the name of the action for an order.

Example: adjust

channelstringOptional

Specifies the channel through which the demand is created.

Example: store, mobile, online

demandSegmentstringOptional

Identifies the segment from which demand has come.

Example: B2B_DEMAND

disableCheckATPbooleanOptional

Responses

200

A 200 success code indicates that the reservation was updated successfully.

application/json

successbooleanOptional

Flag indicating if the request is successful.

Example: true

timestampstring · date-timeOptional

Response timestamp.

Example: 2023-01-24T07:02:38.50405788Z

messagestringOptional

Message conveying success, error, warnings, or any other relevant information.

Example: Request completed successfully.

400

A 400 error code indicates that the request header does not contain a tenant.

application/json

500

A 500 error code indicates that there was some issue while checking out the reservation.

application/json

post

/demand/v1/process-reservations

HTTPcURLJavaScriptPython

POST /services/inventory/demand/v1/process-reservations HTTP/1.1
Host: sandbox.onepint.ai
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 636

{
  "orderType": "SalesOrder",
  "orderNumber": "orderNumber02111902-02",
  "referenceId": "02111902-02",
  "reservationId": "02111902-02",
  "action": "adjust",
  "channel": "store, mobile, online",
  "lines": [
    {
      "action": "adjust",
      "fromSplitIdentifier": "5",
      "lineId": "l1",
      "nodeId": "store-1",
      "itemId": "item-1",
      "quantity": 12234,
      "uom": "EACH",
      "productClass": "GOOD",
      "demandTs": "2026-03-07T05:16:28.677Z",
      "splitIdentifier": "2",
      "fulfillmentType": "SHP",
      "demandSegment": "B2B_DEMAND",
      "extnAttr": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "expiryDate": "2026-03-07",
      "lotNumber": "text"
    }
  ],
  "demandSegment": "B2B_DEMAND",
  "extnAttr": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "disableCheckATP": true
}

{
  "success": true,
  "timestamp": "2023-01-24T07:02:38.50405788Z",
  "message": "Request completed successfully.",
  "payload": [
    {
      "tenant": "NEXTUPLE",
      "channel": "store, mobile, online",
      "reservationId": "02111902-02",
      "orderType": "SalesOrder",
      "orderNumber": "orderNumber02111902-02",
      "referenceId": "02111902-02",
      "lineId": "l1",
      "nodeId": "store-1",
      "itemId": "item-1",
      "quantity": 12234,
      "demandBucket": "RESERVED",
      "uom": "EACH",
      "productClass": "GOOD",
      "demandTs": "2022-12-19T08:52:38.928Z",
      "nodeType": "Store",
      "splitIdentifier": "2",
      "fulfillmentType": "SHP",
      "demandSegment": "B2B_DEMAND",
      "supplySegments": {
        "COMMON": 1
      },
      "supplyLineIds": "[\n  {\n    \"supplyLineId\": \"xyz123\",\n    \"quantity\": 10,\n    \"receiveTs\": \"2022-12-19T08:52:38.928Z\"\n  },\n  {\n    \"supplyLineId\": \"xyz456\",\n    \"quantity\": 5,\n    \"receiveTs\": \"2022-12-20T08:52:38.928Z\"\n  },\n]",
      "extnAttr": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}