Capacity availability

Capacity availability represents the generated output resulting from the resource pool configuration. The Capacity service continuously maintains this availability matrix to support millisecond computation latencies for downstream consuming modules, specifically the Promising and Optimization engines.

Capacity availability identifiers

Capacity availability records are uniquely identified and can be queried using the following parameters:

  • Nodes
    The specific fulfillment locations.
  • Unit of measure
    The tracking metric, such as UNIT or RELEASE.
  • Category ID
    The service category identifier.
  • Resource pool type
    The classification of the pool, such as PROD or CARRIER_SERVICE.
  • Search date range
    The specific search window defined by a FROM date and a TO date.

Key capacity availability tracking metrics

The core information tracked within each capacity availability record includes the following data points:

  • Date and slot
    The specific operational day and the corresponding time windows.
  • Initial capacity
    The baseline start of day capacity value.
  • Available capacity
    The remaining capacity currently available for new consumption.
  • Consumed capacity
    A detailed breakdown of all consumed units categorized by their current transactional status, which includes Open, Confirmed, In Progress, and Completed.

Capacity status lifecyle

Understanding the capacity status is critical for managing the order lifecycle and ensuring transactional integrity. The consumed capacity is segregated into four distinct states:
  • Open
    Capacity captured during the cart checkout phase before it converts into a formalized order. This status carries an associated expiration timer; if the checkout is abandoned and not resolved, the reserved capacity automatically returns to the availability pool.
  • Confirmed
    The capacity state once the order is successfully accepted or created.
  • In Progress
    The capacity state when the order enters the scheduled phase within the fulfillment lifecycle.
  • Completed
    The final stage indicating the shipment is complete.
Note: If you have the IBM OMS-SIP integration adapter enabled for capacity, these statuses automatically transition as the order propagates throughout the fulfillment lifecycle.

Example configuration payload

The following payload provides an example of a capacity availability response, noting that the architecture natively supports pagination for large datasets utilizing the nextPageState attribute: 
{
   "nextPageState": "",
   "fromDate": "2021-08-13",
   "toDate": "2021-09-25",
   "availabilities": [
   {
      "node": "DC_ALABAMA",
      "categoryId": "PRODUCT_SHIP",
      "resourcePoolId": "FULFILLMENT_RESOURCE_POOL",
      "resourcePoolType": "PROD",
      "unitOfMeasure": "LINE",
      "date": "2021-06-15",
      "slot": {
         "startTime": "06:30:00",
         "endTime": "10:30:00"
      },
      "capacity": 12,
      "availableCapacity": 12,
      "consumedCapacity": {
         "openCapacity": 0,
         "completedCapacity": 0,
         "confirmedCapacity": 0,
         "inProgressCapacity": 0
      },
      "timeZone": "US/Eastern"
      },
      {
         "node": "DC_ALABAMA",
         "categoryId": "PRODUCT_PICK",
         "resourcePoolId": "FULFILLMENT_RESOURCE_POOL",
         "unitOfMeasure": "LINE",
         "date": "2021-06-16",
         "slot": {
            "startTime": "06:30:00",
            "endTime": "10:30:00"
      },
      "capacity": 12,
      "availableCapacity": 12,
      "consumedCapacity": {
         "openCapacity": 0,
         "completedCapacity": 0,
         "confirmedCapacity": 0,
         "inProgressCapacity": 0
      },
      "timeZone": "US/Eastern"
      }
   ]
}
For more information, see Capacity availability API.