API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

The Inventory Availability API allows companies (for example, retailers) and suppliers to work with stock levels and view a snapshot of inventory stock for catalog items available to your company.

Suppliers and Companies

Availability can be viewed from the supplier point of view or from the point of view of a company and its locations or stores.

Suppliers and companies are authenticated independently. To access supplier endpoints, you must have an access token reflecting suppliers credentials; to access company endpoints, you must have an access token reflecting company credentials.

Entity Definition

Inventory Availability API calls refer to companies, entities (for example, locations), and suppliers. These entities are all defined in the Entities API.

Availability Thresholds

The Inventory Availability API supports setting minimum availability thresholds. When the minimum thresholds are set, the API reports as “available” only amounts in excess of the threshold. For example, if the minimum threshold for an item is set to 10 and there are 12 items in stock, the API reports 2 items as “available.”

BASE URLS

Demo: https://availabilitydemo.iqmetrix.net/v1
Production: https://availability.iqmetrix.net/v1

RESOURCES

AvailabilityBelowThreshold

The AvailabilityBelowThreshold resource contains detailed availability information for products where stock has fallen below the configured minimum quantity threshold.

{
    "Id": "8c9a6f0f-4725-40d3-be72-9b6c02313991",
    "CompanyId": 14146,
    "EntityId": 14202,
    "ProductId": "3b495ace-8063-43e6-99fc-7809495931cc",
    "Quantity": 3,
    "QuantityOnOrder": 25,
    "QuantityInTransfer": 0,
    "MinQuantity": 10
}
Name Description
Id (GUID) Read-only. Used internally by the system.
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of the entity (for example, a store location), represented as a CompanyTreeNode.
ProductId (GUID) The identifier of the item in the iQmetrix Product Catalog.
Quantity (Integer) The quantity of items currently available for order at this location.
QuantityOnOrder (Integer) The quantity of items on back-order.
QuantityInTransfer (Integer) The quantity of items currently being transferred from another location to this location.
MinQuantity (Integer) The minimum quantity threshold that has been set for this item.
UnitId (Integer) Read-only. A code representing the unit or measure for this item. This value is automatically retrieved by the system from information configured in the iQmetrix Product Catalog. The system does not actually prevent you from modifying this value, but doing so could have deleterious results and we strongly recommend against it.

AvailabilityThreshold

The AvailabilityThreshold resource lets you set, modify, and retrieve information about minimum quantity thresholds for a catalog item.

{
    "Id": "8c9a6f0f-4725-40d3-be72-9b6c02313991",
    "ProductId": "3b495ace-8063-43e6-99fc-7809495931cc",
    "CompanyId": 14146,
    "EntityId": 14202,
    "MinQuantity": 10,
    "UnitId": 3  
}
Name Description
Id (GUID) Read-only. Used internally by the system.
ProductId (GUID) The iQmetrix Product Catalog identifier of the item to which the threshold applies.
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of the entity (for example, a store location), represented as a CompanyTreeNode.
MinQuantity (Integer) The minimum quantity threshold that has been set for this item.
UnitId (Integer) Read-only. A code representing the unit or measure for this item. This value is automatically retrieved by the system from information configured in the iQmetrix Product Catalog. The system does not actually prevent you from modifying this value, but doing so could have deleterious results and we strongly recommend against it.

BulkCatalogProductInStock

The BulkCatalogProductInStock resource represents in-stock availability for a collection of catalog items, represented as CatalogProductInStock resources.

{
    "Id": "5e6db2bd-74e5-4f17-bbf7-fbe214a7aa2e",
    "CatalogProductAvailabilities": [
        {
            "Id": "0785f1b3-b66c-4f8d-bef3-911b66281720",
            "CompanyId": 14146,
            "EntityId": 14202,
            "ProductId": "3b495ace-8063-43e6-99fc-7809495931cc",
            "Quantity": 15,
            "IsDropShippable": false,
            "IsSerialized": false,
            "UnitId": 3
        },
        {
            "Id": "5ff0f764-a98a-418b-8f11-2446f8ab38e9",
            "CompanyId": 14146,
            "EntityId": 14202,
            "Quantity": 0,
            "IsDropShippable": true,
            "IsSerialized": false,
            "IsLot": false,
            "UnitId": 0
        }
    ] 
}
Name Description
Id (GUID) Read-only. Used internally by the system.
CatalogProductAvailabilities Array[CatalogProductInStock] A collection of CatalogProductInStock records showing the availability of each item.

BulkSupplierProductAvailability

The BulkSupplierProductAvailability resource represents availability for catalog items, represented as a collection SupplierProductAvailability records.

{
    "Id": "2a35bb6e-29b0-415d-bfa8-fef8289e98fd",
    "AvailabilityRecords": [
        {
        "Id": "c896e638-0268-4d2f-8764-0e7d315910e6",
        "SupplierSku": "802975856602",
        "SupplierEntityId": 14107,
        "IsAvailable": true,
        "Quantity": 94
        },
        {
        "Id": "5dd0c05b-9be8-4786-9aed-3445eb76cafd",
        "SupplierSku": "802967225488",
        "SupplierEntityId": 14107,
        "IsAvailable": true,
        "Quantity": 234
        }
    ] 
}
Name Description
Id (GUID) The identifier of the resource.
SupplierAvailabilities Array[SupplierProductAvailability] A collection of SupplierProductAvailability records showing availability information for each item.

CatalogProductInStock

The CatalogProductInStock resource represents the availability for an in-stock product.

{
    "Id": "0785f1b3-b66c-4f8d-bef3-911b66281720",
    "CompanyId": 14146,
    "EntityId": 14202,
    "ProductId": "3b495ace-8063-43e6-99fc-7809495931cc",
    "Quantity": 15,
    "IsDropShippable": false,
    "IsSerialized": false,
    "IsLot": false,
    "UnitId": 3
}
Name Description
Id (GUID) The identifier of the CatalogItem in the iQmetrix Product Catalog.
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of the actual entity (for example, a store location), represented as a CompanyTreeNode.
Quantity (Integer) The quantity of items available.
IsDropShippable (Boolean) Indicates whether the catalog item is available to be dropshipped. The default is false.
IsSerialized (Boolean) Indicates whether the product is serialized; that is, has serial numbers or consists of a set of serialized packages. If true, Quantity is determined by a count of the serial numbers or packages. In this case, Quantity is read-only and cannot be manually configured. The default is false.
IsLot (Boolean) Indicates whether this product is available in lots. The default is false.
UnitId (Integer) Read-only. A code representing the unit or measure for this item. This value is automatically retrieved by the system from information configured in the iQmetrix Product Catalog. The system does not actually prevent you from modifying this value, but doing so could have deleterious results and we strongly recommend against it.

CatalogProductInStockLot

The CatalogProductInstockLot resource describes availability for a catalog item that is available in lots. Lots are a collection of serialized packages.

{
    "Id": "FZN-T4E19",
    "CatalogProductId": "e0e9acb6-59a2-49b2-be2f-95354dce82d5",
    "CompanyId": 14146,
    "EntityId": 14202,
    "Packages": [
        {
            "PackageId": "TSN-5978-DD",
            "Quantity": 15
        }
    ]
}
Name Description
Id (String) The identifier of the lot.
CatalogProductId (GUID) The identifier of the item in the iQmetrix Product Catalog.
CompanyId (Integer) The identifier of the Company supplying the item.
EntityId (Integer) The identifier of the actual entity (for example, a store location) supplying the item, represented as a CompanyTreeNode.
Packages Array[Package] A list of the packages included in this lot.

CatalogProductQuantities

[
    {
        "Id": "a183f1a9-c58f-426a-930a-9a6357db52ed",
        "CompanyId": 14146,
        "EntityId": 14202,
        "Quantity": 15,
        "IsSerialized": false,
        "IsDropShippable": false,
        "IsLot": false,
        "QuantityInStock": 15,
        "QuantityOnOrder": 50,
        "QuantityTransferIn": 0,
        "QuantityTransferOut": 0,
        "UnitId": 3
    }
]
Name Description
Id (GUID) The identifier of the CatalogItem in the iQmetrix Product Catalog.
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of the entity (for example, a store location), represented as a CompanyTreeNode.
Quantity (Integer) The quantity of items available for order. This may be the same as the QuantityInStock but it may not, if a minimum quantity has been configured.
IsDropShippable (Boolean) Indicates whether the catalog item is available to be dropshipped. The default is false.
IsSerialized (Boolean) Indicates whether the product is serialized; that is, has serial numbers or consists of a set of serialized packages. If true, Quantity is determined by a count of the serial numbers or packages. In this case, Quantity is read-only and cannot be manually configured. The default is false.
IsLot (Boolean) Indicates whether this product is available in lots. The default is false.
QuantityInStock (Integer) The actual quantity in stock. Not all items in stock are necessarily available, depending on the minimum configured threshold.
QuantityOnOrder (Integer) The quantity that is currently on order.
QuantityTransferIn (Integer) The quantity that is being transferred in.
QuantityTransferOut (Integer) The quantity that is being transferred out.
UnitId (Integer) Read-only. A code representing the unit or measure for this item. This value is automatically retrieved by the system from information configured in the iQmetrix Product Catalog. The system does not actually prevent you from modifying this value, but doing so could have deleterious results and we strongly recommend against it.

CatalogProductQuantitiesDetailed

The CatalogProductQuantitiesDetailed resource presents detailed availability information about a catalog item.

[
    {
        "SerialNumbers": [
            {
                "Id": "B7FQ-RANC-2098",
                "CatalogProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
                "EntityId": 14202,
                "CompanyId": 14146
            },
            {
                "Id": "B7FQ-RANC-2099",
                "CatalogProductId": "87e3dda6-5b33-4bdd-ba7b-1621d7f01bd4",
                "EntityId": 14202,
                "CompanyId": 14202
            }
        ],
        "Lots": [
            {
                "LotId": "4f17-bbf7",
                "Packages": [
                    {
                        "PackageId": "2a35bb6e-29b0-415d-bfa8-fef8289e98fd",
                        "Quantity": 500
                    }
                ]
            },
            {
                "LotId": "87e3dda6-5b33-4bdd-ba7b-1621d7f01bd4",
                "Packages": [
                    {
                        "PackageId": "f71cafd0-b4c5-4874-a755-a4872c10e94e",
                        "Quantity": 150
                    }
                ]
            },
            {
            "Id": "a183f1a9-c58f-426a-930a-9a6357db52ed",
            "CompanyId": 14146,
            "EntityId": 14202,
            "Quantity": 15,
            "IsSerialized": false,
            "IsDropShippable": false,
            "IsLot": false,
            "QuantityInStock": 15,
            "QuantityOnOrder": 50,
            "QuantityTransferIn": 0,
            "QuantityTransferOut": 0,
            "UnitId": 3
            }
        ]
    }
]
Name Description
SerialNumbers Array[SerialNumber] A collection showing quantities for items organized by serial numbers.
Lots Array[Lot] A collection showing quantities for items organized by lots and packages.
Id (GUID) The identifier of the CatalogItem in the iQmetrix Product Catalog.
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of the entity (for example, a store location), represented as a CompanyTreeNode.
Quantity (Integer) The quantity of items available for order. This may be the same as the QuantityInStock but it may not, if a minimum quantity has been configured.
IsDropShippable (Boolean) Indicates whether the catalog item is available to be dropshipped. The default is false.
IsSerialized (Boolean) Indicates whether the product is serialized; that is, has serial numbers or consists of a set of serialized packages. If true, Quantity is determined by a count of the serial numbers or packages. In this case, Quantity is read-only and cannot be manually configured. The default is false.
IsLot (Boolean) Indicates whether this product is available in lots. The default is false.
QuantityInStock (Integer) The actual quantity in stock. Not all items in stock are necessarily available, depending on the minimum configured threshold.
QuantityOnOrder (Integer) The quantity that is currently on order.
QuantityTransferIn (Integer) The quantity that is being transferred in.
QuantityTransferOut (Integer) The quantity that is being transferred out.
UnitId (Integer) Read-only. A code representing the unit or measure for this item. This value is automatically retrieved by the system from information configured in the iQmetrix Product Catalog. The system does not actually prevent you from modifying this value, but doing so could have deleterious results and we strongly recommend against it.

Lot

The Lot resource represents a product that is available as a collection of Packages.

{
    "LotId": "4f17-bbf7",
    "Packages": [
        {
            "PackageId": "2a35bb6e-29b0-415d-bfa8-fef8289e98fd",
            "Quantity": 500
        }
    ]
}
Name Description
LotId (String) The identifier of the lot.
Packages Array[Package] The collections contained by this lot.

Package

The Package resource represents a kind of serialized item, such as a set of items with serial numbers or a quantity of a particular line of a product. Packages can be aggregated into lots.

{
    "PackageId": "2a35bb6e-29b0-415d-bfa8-fef8289e98fd",
    "Quantity": 500
}
Name Description
PackageId (GUID) The identifier of the set of serialized items.
Quantity (Integer) The number of this kind of serialized items in the package.

SerialNumber

{
    "Id": "B7FQ-RANC",
    "CatalogProductId": "a183f1a9-c58f-426a-930a-9a6357db52ed",
    "EntityId": 14202,
    "CompanyId": 14146
}
Name Description
Id (String) The serial number or package identifier of the item.
CatalogProductId (GUID) The identifier of the item in the iQmetrix Product Catalog.
EntityId (Integer) The identifier of the actual entity (such as an individual store or location), represented as a CompanyTreeNode.
CompanyId (Integer) The identifier of the Company.

SupplierProductAvailability

The SupplierProductAvailability resource represents the availability of an item to a given supplier.

[
    {
        "Id": "c896e638-0268-4d2f-8764-0e7d315910e6",
        "SupplierSku": "802975856602",
        "SupplierEntityId": 14107,
        "IsAvailable": true,
        "Quantity": 94
    }
]
Name Description
Id (GUID) The identifier of the item.
SupplierSku (String) The SKU used by this supplier for this item.
SupplierEntityId (Integer) The identifier of the Supplier.
IsAvailable (Boolean) Indicates whether the item is available.
Quantity (Integer) The quantity of items available.

REQUESTS

GET Availability for All Catalog Items (All Locations)

Use this request to retrieve availability information for all the catalog items available within a company.

Request

GET /Companies({CompanyId})/CatalogItems

Example Request

GET /Companies(99225)/CatalogItems
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

curl -X GET "https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/CatalogItems" -H "Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q" -H "Accept: application/json" -H -d 
static IRestResponse ConfiguringAvailability()
{
    var client = new RestClient("https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/CatalogItems");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q"); 
    request.AddHeader("Accept", "application/json"); 

    return client.Execute(request);
}
import org.apache.http.entity.StringEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GetCatalogItemAvailability() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost request = new HttpPost("https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/CatalogItems");
     
    request.addHeader("Authorization", "Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q"); 
    request.addHeader("Accept", "application/json"); 

    
    return httpClient.execute(request);
}
require 'rest-client'

response = RestClient.get 'https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/CatalogItems', body, {
     :'Authorization' => 'Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q',
     :'Accept' => 'application/json',
    } 

puts response

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "9d5009c7-9a07-4dfd-8319-007cd4a1c642",
        "CompanyId": 99225,
        "EntityId": 99225,
        "Quantity": 34,
        "IsDropShippable": false,
        "IsSerialized": false,
        "IsLot": false,
        "UnitId": 0
    },
    {
        "Id": "e0594c5e-0aa6-4587-a5f9-00c9c4ba59d1",
        "CompanyId": 99225,
        "EntityId": 99234,
        "Quantity": 10,
        "IsDropShippable": false,
        "IsSerialized": false,
        "IsLot": false,
        "UnitId": 0
    },
    {
        "Id": "a2e4b300-637e-440b-b4de-011f8eeffac2",
        "CompanyId": 99225,
        "EntityId": 99234,
        "Quantity": 0,
        "IsDropShippable": true,
        "IsSerialized": false,
        "IsLot": false,
        "UnitId": 0
    }
]

A successful request returns a 200 (OK) response code with the information for all catalog items stocked by the company, represented as CatalogProductInStock resources. For a description of properties defined for the CatalogProductInStock resource, see CatalogProductInStock.

GET Availability for All Catalog Items (Specific Location)

Use this request to retrieve availability information for all the catalog items available at a given location–for example, at a specific store.

Request

GET /Companies({CompanyId})/Entities({EntityId})/CatalogItems

Example Request

GET /Companies(99225)/Entities(99234)/CatalogItems
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

curl -X GET "https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/Entities(99234)/CatalogItems" -H "Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q" -H "Accept: application/json" -H -d 
static IRestResponse ConfiguringAvailability()
{
    var client = new RestClient("https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/Entities(99234)/CatalogItems");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q"); 
    request.AddHeader("Accept", "application/json"); 

    return client.Execute(request);
}
import org.apache.http.entity.StringEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GetCatalogItemAvailability() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost request = new HttpPost("https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/Entities(99234)/CatalogItems");
     
    request.addHeader("Authorization", "Bearer AbCdEf123456"); 
    request.addHeader("Accept", "application/json"); 

    
    return httpClient.execute(request);
}
require 'rest-client'

response = RestClient.get 'https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/Entities(99234)/CatalogItems', body, {
     :'Authorization' => 'Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q',
     :'Accept' => 'application/json',
    } 

puts response

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of the entity (for example, a store location), represented as a CompanyTreeNode.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "e0594c5e-0aa6-4587-a5f9-00c9c4ba59d1",
        "CompanyId": 99225,
        "EntityId": 99234,
        "Quantity": 10,
        "IsDropShippable": false,
        "IsSerialized": false,
        "IsLot": false,
        "UnitId": 0
    },
    {
        "Id": "a2e4b300-637e-440b-b4de-011f8eeffac2",
        "CompanyId": 99225,
        "EntityId": 99234,
        "Quantity": 0,
        "IsDropShippable": true,
        "IsSerialized": false,
        "IsLot": false,
        "UnitId": 0
    }
]

A successful request returns a 200 (OK) response code with the information for all catalog items stocked by that location, represented as CatalogProductInStock resources. For a description of properties defined for the CatalogProductInStock resource, see CatalogProductInStock.

GET Availability for a Specific Catalog Item (All Locations)

Use this request to determine availability of a specific item at all locations in a company.

Request

GET /Companies({CompanyId})/CatalogItems({CatalogItemId})/Availability

Example Request

GET /Companies(99225)/CatalogItems(aab0bddb-9305-4354-b24c-87afaba6df98)/Availability
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

curl -X GET "https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/CatalogItems(aab0bddb-9305-4354-b24c-87afaba6df98)/Availability" -H "Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q" -H "Accept: application/json"
static IRestResponse GetCatalogItemAvailability_AllLocations()
{
    var client = new RestClient("https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/CatalogItems(aab0bddb-9305-4354-b24c-87afaba6df98)/Availability");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q"); 
    request.AddHeader("Accept", "application/json"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GetCatalogItemAvailability_AllLocations() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/CatalogItems(aab0bddb-9305-4354-b24c-87afaba6df98)/Availability");
     
    request.addHeader("Authorization", "Bearer AbCdEf123456"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/CatalogItems(aab0bddb-9305-4354-b24c-87afaba6df98)/Availability', {
     :'Authorization' => 'Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q',
     :'Accept' => 'application/json',
    } 

puts response

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
CatalogProductId (GUID) The identifier of the item in the iQmetrix Product Catalog.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "aab0bddb-9305-4354-b24c-87afaba6df98",
        "CompanyId": 99225,
        "EntityId": 99225,
        "Quantity": 0,
        "IsDropShippable": false,
        "IsSerialized": false,
        "IsLot": false,
        "UnitId": 0
    },
    {
        "Id": "aab0bddb-9305-4354-b24c-87afaba6df98",
        "CompanyId": 99225,
        "EntityId": 99227,
        "Quantity": 62,
        "IsDropShippable": false,
        "IsSerialized": false,
        "IsLot": false,
        "UnitId": 0
    },
    {
        "Id": "aab0bddb-9305-4354-b24c-87afaba6df98",
        "CompanyId": 99225,
        "EntityId": 118219,
        "Quantity": 1033,
        "IsDropShippable": false,
        "IsSerialized": false,
        "IsLot": false,
        "UnitId": 0
    },
    {
        "Id": "aab0bddb-9305-4354-b24c-87afaba6df98",
        "CompanyId": 99225,
        "EntityId": 133084,
        "Quantity": 4,
        "IsDropShippable": false,
        "IsSerialized": false,
        "IsLot": false,
        "UnitId": 0
    }
]

A successful request returns a 200 (OK) response code with the information for all catalog items stocked by that location, represented as CatalogProductInStock resources. For a description of properties defined for the CatalogProductInStock resource, see CatalogProductInStock.

GET Availability for a Specific Catalog Item (Specific Location)

Use this request to determine availability of a specific item at a given location in a company.

Request

GET /Companies({CompanyId})/Entities({LocationId})/CatalogItems({CatalogItemId})

Example Request

GET /Companies(99225)/Entities(118219)/CatalogItems(aab0bddb-9305-4354-b24c-87afaba6df98)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

curl -X GET "https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/Entities(118219)/CatalogItems(aab0bddb-9305-4354-b24c-87afaba6df98)" -H "Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q" -H "Accept: application/json"
static IRestResponse GettingCatalogItemAvailability_Location()
{
    var client = new RestClient("https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/Entities(118219)/CatalogItems(aab0bddb-9305-4354-b24c-87afaba6df98)");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q"); 
    request.AddHeader("Accept", "application/json"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingCatalogItemAvailability_Location() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/Entities(118219)/CatalogItems(aab0bddb-9305-4354-b24c-87afaba6df98)");
     
    request.addHeader("Authorization", "Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://availabilitydemo.iqmetrix.net/v1/Companies(99225)/Entities(118219)/CatalogItems(aab0bddb-9305-4354-b24c-87afaba6df98)', {
     :'Authorization' => 'Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q',
     :'Accept' => 'application/json',
    } 

puts response

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of the entity (for example, a store location), represented as a CompanyTreeNode.
CatalogProductId (GUID) The identifier of the item in the iQmetrix Product Catalog.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "aab0bddb-9305-4354-b24c-87afaba6df98",
    "CompanyId": 99225,
    "EntityId": 118219,
    "Quantity": 1033,
    "IsDropShippable": false,
    "IsSerialized": false,
    "IsLot": false,
    "UnitId": 0
}

A successful request returns a 200 (OK) response code with the item availability information at the specified location, represented as a CatalogProductInStock resource. For a description of properties defined for the CatalogProductInStock resource, see CatalogProductInStock.

Was this page helpful?