Get Inventory

This API retrieves the inventory details for one or more SKUs from one or more facilities. When the facility is not provided in the request, network level inventory will be returned by the call.

Swagger

			
swagger: '2.0'
info:
  x-ibm-name: inventory
  title: Inventory
  version: 1.0.0
schemes:
  - https
host: $(catalog.host)
basePath: /v1
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  oauth2:
    type: oauth2
    description: ''
    flow: accessCode
    authorizationUrl: 'https://<........................>/fsc/oauth2/authorize'
    scopes:
      Fulfillment_Returns: ''
    tokenUrl: 'https://<........................>/fsc/oauth2/token'
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
    description: Enter Client Id
  clientSecretHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Secret
    description: Enter Client Secret
security:
  - clientIdHeader: []
    clientSecretHeader: []
    oauth2:
      - Fulfillment_Returns
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /inventory:
    get:
      responses:
        200:
          description: 200 OK
      summary: Get Inventory
      description: Retrieves the inventory details for one or more SKUs from one or
        more facilities. When facility is not provide in the request, network level
        inventory will be returned by the call.
      parameters:
      - name: sku
        type: string
        required: false
        in: query
        description: SKU of the Product. This parameter allows upto 25 SKUs.
      - name: facility
        type: string
        required: false
        in: query
        description: Inventory information need to be retrieved from a specific facility.
          If facility is not specified, response will return network level inventory
          across all facilities.
      - name: pageLimit
        type: string
        required: false
        in: query
        description: 'Number of records to be retrieved in each page. Allowed values:
          1 to 100. Default is 50.'
			
		

Sample Request

			
•	Retrieve network level inventory details for all the SKUs across all facilities
https://<........>/api/v1/inventory
•	Retrieve network level inventory details of the SKUs provided across all facilities
https://<........>/api/v1/inventory?sku=CD8560,003-003-0001,005-001-001,OILPULL2
•	Retrieve inventory details of the SKUs provided from HFY facility
https://<........>/api/v1/inventory?sku=CD8560,003-003-0001,005-001-001,OILPULL2&facility=HFY
			
		

Sample Response

Success Response

			
 {
  "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
   "transactionDate": "2017-01-20T15:12:54-05:00",
  "inventory": [
    {
      "sku": "003-003-0001",
      "facility": "HFY",
      "availableCount": 1782,
      "blockedCount": 12,
      "inboundInventoryCount": 52,
      "inboundReturnCount": 15,
      "allocatedCount": 5,
      "backorderedCount": 0
    },
    {
      "sku": "003-003-0002",
      "facility": "HFY",
      "availableCount": 1451,
      "blockedCount": 20,
      "inboundInventoryCount": 52,
      "inboundReturnCount": 15,
      "allocatedCount": 121,
      "backorderedCount": 5
    },
    {
      "sku": "003-003-0003",
      "facility": "HFY",
      "availableCount": 180,
      "blockedCount": 0,
      "inboundInventoryCount": 52,
      "inboundReturnCount": 15,
      "allocatedCount": 1,
      "backorderedCount": 15
    },
    {
      "sku": "Picante",
      "facility": "HFY",
      "availableCount": 901,
      "blockedCount": 0,
      "inboundInventoryCount": 52,
      "inboundReturnCount": 15,
      "allocatedCount": 0,
      "backorderedCount": 0
    }
  ],
  "paging": {
    "previous": "https://<.........>/api/v1/inventory?pageLimit=25&offset=0",
    "next": "https://<............>/api/v1/inventory?pageLimit=25&offset=50"
  }
}

			
		

OAuth 2.0

Custom authentication

Query Parameter

Response Attribute

HTTP Status Code

Error Code