Availability APIs

Get Bulk Availabilities

post

https://sandbox.onepint.ai/services/availabilityhttps://prod.onepint.ai/services/availability

/avail/v3/bulk-availability

Retrieves availabilities for given item and set of nodes with other filters for a tenant.

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.

Query parameters

returnAtpBySegmentsbooleanOptional

Indicates whether the user needs the ATP (Available to Promise) belonging to each supply segment.

Default: falseExample: true

demandSegmentstringOptional

Identifies the segment from which demand has come.

Example: B2B_DEMAND

considerFutureAtpbooleanOptional

Indicates whether Future ATP (Available to Promise) should be considered

Default: falseExample: true

Body

application/json

availTypestringOptional

Specifies the type of the availability rule.

Example: ON_HAND_PROMISE

considerMinAtpbooleanOptional

Specifies whether the minimum ATP of the node and the network should be considered when calculating node ATP. If the minimum ATP is not passed, the default value of this flag will be retrieved from the properties file.

Example: true

considerSafetyStockbooleanOptional

Specifies whether the safety stock is to be considered or not during the availability calculation.

Example: true

Responses

200

A 200 success code indicates that the availabilities were fetched 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 there was some issue with the request.

application/json

500

A 500 error code indicates that there was some issue while retrieving availabilities.

application/json

post

/avail/v3/bulk-availability

HTTPcURLJavaScriptPython

POST /services/availability/avail/v3/bulk-availability HTTP/1.1
Host: sandbox.onepint.ai
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "availType": "ON_HAND_PROMISE",
  "considerMinAtp": true,
  "considerSafetyStock": true,
  "lines": [
    {
      "itemId": "item-1",
      "bundleItemId": "text",
      "nodeIds": [
        "store-1",
        "store-2"
      ],
      "productClass": "GOOD",
      "uom": "EACH",
      "fulfillmentType": "SHP",
      "expiryDate": "2026-03-07",
      "returnAtpByExpiryDate": true
    }
  ]
}

{
  "success": true,
  "timestamp": "2023-01-24T07:02:38.50405788Z",
  "message": "Request completed successfully.",
  "payload": {
    "tenant": "NEXTUPLE",
    "availType": "ON_HAND_PROMISE",
    "demandSegment": "B2B_DEMAND",
    "availLineRespList": [
      {
        "itemId": "item-1",
        "nodeId": "store-1",
        "productClass": "GOOD",
        "uom": "EACH",
        "quantity": 100,
        "fulfillmentType": "SHP",
        "quantityBySupplySegments": [
          {
            "supplySegment": "B2B",
            "quantity": 140
          }
        ],
        "futureAtpDetails": [
          {
            "startTs": "2025-01-01T00:00:00Z",
            "endTs": "2025-01-02T00:00:00Z",
            "quantity": 100,
            "quantityBySupplySegments": [
              {
                "supplySegment": "B2B",
                "quantity": 140
              }
            ]
          }
        ]
      }
    ]
  }
}