Scenario: Get Location Specific Quantity for Item(s)


MethodName: GetItemLocationQuantity()


Inputs:

  • APIToken
  • Item
    • Required, used for linking items
    • Note: Item can be passed multiple times.


Example for Requesting Location Specific Inventory for 1 Item


Request:

https://localhost:50938/c5coreapi/?APIToken=uta9A5Od&action=GetItemLocationQuantity&Item=008080043641


Response:

{
  "Items": [{
    "Item": "008080043641",
    "LocationQty": [{
      "Location": "0001",
      "Quantity": 1.0000
    },
    {
      "Location": "0002",
      "Quantity": 0.0000
    },
    {
      "Location": "0003",
      "Quantity": 0.0000
    },
    {
      "Location": "0004",
      "Quantity": 5.0000
    },
    {
      "Location": "0006",
      "Quantity": 0.0000
    },
    {
      "Location": "0007",
      "Quantity": 4.0000
    },
    {
      "Location": "0008",
      "Quantity": 0.0000
    },
    {
      "Location": "0010",
      "Quantity": 2.0000
    },
    {
      "Location": "0011",
      "Quantity": 0.0000
    },
    {
      "Location": "0012",
      "Quantity": 0.0000
    },
    {
      "Location": "0014",
      "Quantity": 5.0000
    },
    {
      "Location": "0015",
      "Quantity": 0.0000
    },
    {
      "Location": "0016",
      "Quantity": 5.0000
    },
    {
      "Location": "0017",
      "Quantity": 3.0000
    },
    {
      "Location": "0018",
      "Quantity": 0.0000
    },
    {
      "Location": "0019",
      "Quantity": 0.0000
    },
    {
      "Location": "0020",
      "Quantity": 0.0000
    },
    {
      "Location": "0021",
      "Quantity": 0.0000
    },
    {
      "Location": "0022",
      "Quantity": 0.0000
    },
    {
      "Location": "0099",
      "Quantity": 0.0000
    },
    {
      "Location": "WEB",
      "Quantity": 0.0000
    }]
  }]
}



Note: The Location Specific Qty is returned for ALL locations.



Example for Requesting Location Specific Inventory for MULTIPLE items


Request:

https://localhost:50938/c5coreapi/?APIToken=uta9A5Od&action=GetItemLocationQuantity&Item=008080043641&Item=008080044082


Note: You can request location specific inventory for as many items as needed by appending &Item to the request


Response:

{
  "Items": [{
    "Item": "008080043641",
    "LocationQty": [{
      "Location": "0001",
      "Quantity": 1.0000
    },
    {
      "Location": "0002",
      "Quantity": 0.0000
    },
    {
      "Location": "0003",
      "Quantity": 0.0000
    },
    {
      "Location": "0004",
      "Quantity": 5.0000
    },
    {
      "Location": "0006",
      "Quantity": 0.0000
    },
    {
      "Location": "0007",
      "Quantity": 4.0000
    },
    {
      "Location": "0008",
      "Quantity": 0.0000
    },
    {
      "Location": "0010",
      "Quantity": 2.0000
    },
    {
      "Location": "0011",
      "Quantity": 0.0000
    },
    {
      "Location": "0012",
      "Quantity": 0.0000
    },
    {
      "Location": "0014",
      "Quantity": 5.0000
    },
    {
      "Location": "0015",
      "Quantity": 0.0000
    },
    {
      "Location": "0016",
      "Quantity": 5.0000
    },
    {
      "Location": "0017",
      "Quantity": 3.0000
    },
    {
      "Location": "0018",
      "Quantity": 0.0000
    },
    {
      "Location": "0019",
      "Quantity": 0.0000
    },
    {
      "Location": "0020",
      "Quantity": 0.0000
    },
    {
      "Location": "0021",
      "Quantity": 0.0000
    },
    {
      "Location": "0022",
      "Quantity": 0.0000
    },
    {
      "Location": "0099",
      "Quantity": 0.0000
    },
    {
      "Location": "WEB",
      "Quantity": 0.0000
    }]
  },
  {
    "Item": "008080044082",
    "LocationQty": [{
      "Location": "0001",
      "Quantity": 0.0000
    },
    {
      "Location": "0002",
      "Quantity": 5.0000
    },
    {
      "Location": "0003",
      "Quantity": 0.0000
    },
    {
      "Location": "0004",
      "Quantity": 5.0000
    },
    {
      "Location": "0006",
      "Quantity": 0.0000
    },
    {
      "Location": "0007",
      "Quantity": 0.0000
    },
    {
      "Location": "0008",
      "Quantity": 0.0000
    },
    {
      "Location": "0010",
      "Quantity": 0.0000
    },
    {
      "Location": "0011",
      "Quantity": 0.0000
    },
    {
      "Location": "0012",
      "Quantity": 0.0000
    },
    {
      "Location": "0014",
      "Quantity": 0.0000
    },
    {
      "Location": "0015",
      "Quantity": 2.0000
    },
    {
      "Location": "0016",
      "Quantity": 1.0000
    },
    {
      "Location": "0017",
      "Quantity": 0.0000
    },
    {
      "Location": "0018",
      "Quantity": 0.0000
    },
    {
      "Location": "0019",
      "Quantity": 0.0000
    },
    {
      "Location": "0020",
      "Quantity": 0.0000
    },
    {
      "Location": "0021",
      "Quantity": 0.0000
    },
    {
      "Location": "0022",
      "Quantity": 0.0000
    },
    {
      "Location": "0099",
      "Quantity": 0.0000
    },
    {
      "Location": "WEB",
      "Quantity": 0.0000
    }]
  }]
}



Magento SKU Linking to Counterpoint Items


The Commerce5 API will attempt to link an Item Request in multiple ways

  • An item will attempt to be linked to a Counterpoint Item Number or Barcode
  • If the item requested contains a | then it will be parsed to identify the corresponding item number and grid cells
  • Example: 
    • Magento SKU: SHIRT|BLUE|SMALL
    • Parsed by Commerce5 API to link to the Gridded item "SHIRT" with Color "BLUE" and Size "SMALL"