Get aggregated networks

This endpoint lets you view the aggregated count of the inventory-network based on the network rule configuration (either by network ID or by SKU, or by both).

GET /inventory/aggregatedNetwork/query

Try it

Get aggregated networks

cURL

curl --request GET \
  --url https://prod01.oms.fabric.inc/api/v2/inventory/aggregatedNetwork/query \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'

200

{
  "pagination": {
    "total": 100,
    "limit": 10,
    "offset": 0
  },
  "networkAggregation": [
    {
      "networkCode": "Ship-to-home",
      "sku": "SKU00025",
      "virtualCounters": {
        "availableToPurchase": 50
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context · string · required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Query Parameters

networkSearchModel · object · required

Show child attributes

networkSearchModel. networkId · string

Network ID

Example:

"62278e49167b6079755aa5e7"

networkSearchModel. sku · string

Network SKU

Example:

"SKU00025"

paginationQueryModel · object · required

This object represents the process of separating data into different pages

Show child attributes

paginationQueryModel. limit · integer<int32>

Number of records returned on a single page, default is 10 if limit is not specified

paginationQueryModel. offset · integer<int64>

Number of records you wish to skip before selecting records, default is 0 if not specified

Response

200

application/json

OK

pagination · object

This object represents the process of separating data into different pages

Show child attributes

pagination. total · integer<int64>

Total number of records

Example:

100

pagination. limit · integer<int32>

Number of records returned on a single page

Example:

10

pagination. offset · integer<int64>

Number of records skipped before selecting the records

Example:

0

networkAggregation · object[]

Show child attributes

networkAggregation. networkCode · string

Network code. A unique code name associated with the network for identification.

Example:

"Ship-to-home"

networkAggregation. sku · string

Network SKU

Example:

"SKU00025"

networkAggregation. virtualCounters · object

Inventory quantity that is available to purchase.

Example:

{ "availableToPurchase": 50 }