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 an entity, represented as a CompanyTreeNode. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a company.
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 an entity, represented as a CompanyTreeNode. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a company.
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.

CatalogProductCommitted

When products are put on hold, there needs to be a mechanism to ensure that product that has been added to a sales order but not removed from the store (for example, because it has been purchased online) is not sold in-store before the online customer has had a chance to pick it up. The CatalogProductCommitted resource captures the information for designating inventory as “committed.”

{
  "Id": "CF0EBCC9-3C47-46D5-8AC0-0C7BBEA05886",
  "CatalogProductId": "E555108C-CA19-4669-972A-A45C0EAB0D92",
  "EntityId": "91246",
  "Quantity": 1
}

Name Description
Id (GUID) An identifier for the product commit. You can specify this identifier as input; alternatively, you can allow the system to generate a GUID for the commit.
EntityId (Integer) The identifier of the entity associated with committing this product. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a company.
CatalogProductId (GUID) The catalog identifier of the product being committed.
Quantity (Integer) The quantity of product to commit.

CatalogProductHoldBatch

Products that are purchased online need a mechanism for ensuring the products are reserved, not shown as available for purchase in store before the sales order has been created in RQ. Placing a product “on hold” reserves the inventory for online orders between the time the order is placed online and the time the sales order is created in RQ. A CatalogProductHoldBatch records information for one or more products being placed on hold.

{
	"Id": "A85905EF-DA40-4A5D-B1A3-F7877A4AF429",
	"EntityId": 91246,
	"HoldDurationInMinutes": 60,
	"ExpiresAtUtc": "2018-06-08T22:38:19",
	"Products": [
        {
		"CatalogProductId": "BF8B98F7-9C7A-4D09-A9D3-81A2544FBE13",
		"Quantity": 1
	    },
	    {
		"CatalogProductId": "32C2860E-C450-4776-A1E6-F1A78BE09AFC",
		"Quantity": 220
	    }
    ]
}
Name Description
Id (GUID) The identifier of the hold batch. You can specify this identifier as input; alternatively, you can allow the system to generate a GUID for the hold batch.
EntityId (Integer) The identifier of the entity associated with this product hold. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a company.
HoldDurationInMinutes (DateTime) The time at which this hold will expire. Must be greater than zero.
ExpiresAtUtc (DateTime) Read-only. The time at which this hold will expire, as calculated from the specified hold duration.
Products Array[ProductHold] A list of the products on hold in this hold batch. Must include at least one product.

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 an entity, represented as a CompanyTreeNode. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a company.
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 an entity, represented as a CompanyTreeNode. The entity can be the same as the company identifier, or it can be different–for example, to represent a specific store within a company.
Packages Array[Package] A list of the packages included in this lot.

CatalogProductOnHold

A CatalogProductOnHold resource records information for a single product that is on hold.

{
	"Id": "A85905EF-DA40-4A5D-B1A3-F7877A4AF429",
	"EntityId": "14146",
	"CatalogProductId": "BF8B98F7-9C7A-4D09-A9D3-81A2544FBE13",
	"Quantity": 1
}
Name Description
Id (GUID) The identifier of the hold batch to which this product belongs.
EntityId (Integer) The identifier of the entity associated with this product hold. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a company.
ExpiresAtUtc (DateTime) Read-only. The time at which this hold will expire, as calculated from the specified hold duration.
CatalogProductId (GUID) The catalog identifier of the product on hold.
Quantity (Integer) The quantity of product on hold. Must be greater than zero.

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 an entity, represented as a CompanyTreeNode. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a company.
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 an entity, represented as a CompanyTreeNode. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a company.
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.

ProductHold

The ProductHold resource allows you to specify a product you want to place on hold within a batch of on-hold products.

{
		"CatalogProductId": "BF8B98F7-9C7A-4D09-A9D3-81A2544FBE13",
		"Quantity": 22
}
Name Description
CatalogProductId (GUID) The catalog identifier of the product being put on hold.
Quantity (Integer) The quantity of product to put on hold.

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 an entity, 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,
        "LastModifiedDateUtc": "2015-08-11T20:58:02.71"
    }
]
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.
LastModifiedDateUtc Read-only. The date and time of the most recent update to the record, in UTC. The system initially sets this value to the date of creation and revises it with every update to the record.

REQUESTS

GET Availability for All Catalog Items (Company)

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

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 (Entity)

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

Request

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

Example Request

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

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of an entity, represented as a CompanyTreeNode. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a company.

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 (Company)

Use this request to determine availability of a specific item for 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

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 (Entity)

Use this request to determine availability of a specific item for a specific entity within 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

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of an entity, represented as a CompanyTreeNode. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a 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": 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.

Add Catalog Product Availability (Company)

Use this request to set availability for a catalog item across a company.

Request

POST /Companies({CompanyId})/CatalogItems

Example Request

POST /Companies(457549)/CatalogItems
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

{
    "Id": "3f6640f5-4463-49c4-866e-96450bb7c098",
    "CompanyId": 457549,
    "EntityId": 459148,
    "Quantity": 10,
    "IsDropShippable": false,
    "IsSerialized": false
}

Path Parameters

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

Request Parameters

Name Description
Id (GUID) Required. The identifier of the CatalogItem in the iQmetrix Product Catalog.
CompanyId (Integer) Required. The identifier of the Company.
EntityId (Integer) Required. The identifier of an entity, represented as a CompanyTreeNode. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a company.
Quantity (Integer) Required. The quantity of items available.
IsDropShippable (Boolean) Optional. Indicates whether the catalog item is available to be dropshipped. The default is false.
IsSerialized (Boolean) Optional. 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) Optional. Indicates whether this product is available in lots. The default is false.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "3f6640f5-4463-49c4-866e-96450bb7c098",
    "CompanyId": 457549,
    "EntityId": 459148,
    "Quantity": 10,
    "IsDropShippable": false,
    "IsSerialized": false,
    "IsLot": false,
    "UnitId": 0
}

A successful request returns a 201 (Created) response code with the information for the new product availability record, represented as a CatalogProductInStock resource. For a description of properties defined for the CatalogProductInStock resource, see CatalogProductInStock.

Add or Update Catalog Product Availability (Entity)

Use this request to set or change availability information for all the catalog items available for a specific entity.

Request

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

Example Request

POST /Companies(472439)/Entities(472445)/CatalogItems
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

{
    "Id": "3f6640f5-4463-49c4-866e-96450bb7c098",
    "CompanyId": 472439,
    "EntityId": 472445,
    "Quantity": 10,
    "IsDropShippable": false,
    "IsSerialized": false
}

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of an entity, represented as a CompanyTreeNode.

Request Parameters

Name Description
Id (GUID) Required. The identifier of the CatalogItem in the iQmetrix Product Catalog.
CompanyId (Integer) Required. The identifier of the Company.
EntityId (Integer) Required. The identifier of an entity, represented as a CompanyTreeNode. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a company.
Quantity (Integer) Required. The quantity of items available.
IsDropShippable (Boolean) Optional. Indicates whether the catalog item is available to be dropshipped. The default is false.
IsSerialized (Boolean) Optional. 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) Optional. Indicates whether this product is available in lots. The default is false.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "3f6640f5-4463-49c4-866e-96450bb7c098",
    "CompanyId": 457549,
    "EntityId": 459148,
    "Quantity": 10,
    "IsDropShippable": false,
    "IsSerialized": false,
    "IsLot": false,
    "UnitId": 0
}

A successful request to add product availability returns a 201 (Created) response code with the information for the new product availability record. A successful request to update product availability returns a 200 (OK) response code with the information for the updated record. Information is represented as a CatalogProductInStock resource. For a description of properties defined for the CatalogProductInStock resource, see CatalogProductInStock.

DELETE Catalog Product Availability (Entity)

Use this request to delete a catalog product availability record for an entity.

Request

DELETE /Companies({CompanyId})/Entities({EntityId})/CatalogItems({CatalogItemId})

Example Request

DELETE /Companies(472439)/Entities(472445)/CatalogItems(97974470-1496-40be-80ff-966086b92cdf)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

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

Request Parameters

None.

Response

Example Response

HTTP 204 Content-Type: application/json

A successful request returns a 204 (No Content) response code.

Add Bulk Catalog Product Availability (Company)

Use this request to add multiple catalog product availability records in a single request. This request is scoped at the company level.

Request

POST /Companies({CompanyId})/BulkAvailability

Example Request

POST /Companies(472439)/BulkAvailability
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

[
    {
        "Id": "3f6640f5-4463-49c4-866e-96450bb7c098",
        "CompanyId": 472439,
        "EntityId": 472445,
        "Quantity": 10,
        "IsDropShippable": false,
        "IsSerialized": false
    },
    {
        "Id": "f4c5788f-23c1-463b-adcf-7c0beb222cc3",
        "CompanyId": 472439,
        "EntityId": 472445,
        "Quantity": 25,
        "IsDropShippable": true,
        "IsSerialized": false
    }
]

Path Parameters

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

Request Parameters

Name Description
Id (GUID) Required. The identifier of the CatalogItem in the iQmetrix Product Catalog.
CompanyId (Integer) Required. The identifier of the Company.
EntityId (Integer) Required. The identifier of an entity, represented as a CompanyTreeNode. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a company.
Quantity (Integer) Required. The quantity of items available.
IsDropShippable (Boolean) Optional. Indicates whether the catalog item is available to be dropshipped. The default is false.
IsSerialized (Boolean) Optional. 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) Optional. Indicates whether this product is available in lots. The default is false.

Response

Example Response

HTTP 200 Content-Type: application/json

[
    {
        "Id": "3f6640f5-4463-49c4-866e-96450bb7c098",
        "CompanyId": 472439,
        "EntityId": 472445,
        "Quantity": 10,
        "IsDropShippable": false,
        "IsSerialized": false,
        "IsLot": false,
        "UnitId": 0
    },
    {
        "Id": "f4c5788f-23c1-463b-adcf-7c0beb222cc3",
        "CompanyId": 472439,
        "EntityId": 472445,
        "Quantity": 25,
        "IsDropShippable": true,
        "IsSerialized": false,
        "IsLot": false,
        "UnitId": 0
    }
]

A successful request returns a 202 (Accepted) response with the added information represented as an array of CatalogProductInStock resources. For a description of properties defined for the CatalogProductInStock resource, see CatalogProductInStock.

GET Bulk Product Availability (Entity)

Use this request to list availability at an entity for a list of products.

Note that this request uses a POST request (not a GET) to retrieve the specified information. The list of products to retrieve is specified in the body of the request.

Request

POST /Companies({CompanyId})/Entities({LocationId})/ProductList

Example Request

POST /Companies(457549)/Entities(459148)/ProductList
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

{
  "CatalogProductAvailabilities": [
    {
      "Id": "83b7a2a9-e0fa-4c15-af3d-3a4fbdc13f5b"
    },
    {
      "Id": "180d9885-5203-42b7-a652-d5f786d76c9e"
    }
  ]
}

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of an entity, represented as a CompanyTreeNode.

Request Parameters

Name Description
Id (GUID) Required. The catalog product identifier of the item.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "CatalogProductAvailabilities": [
        {
            "Id": "83b7a2a9-e0fa-4c15-af3d-3a4fbdc13f5b",
            "CompanyId": 457549,
            "EntityId": 459148,
            "Quantity": 10,
            "IsDropShippable": false,
            "IsSerialized": false,
            "IsLot": false,
            "UnitId": 0
        },
        {
            "Id": "180d9885-5203-42b7-a652-d5f786d76c9e",
            "CompanyId": 457549,
            "EntityId": 459148,
            "Quantity": 25,
            "IsDropShippable": true,
            "IsSerialized": false,
            "IsLot": false,
            "UnitId": 0
        }
    ]
}

A successful request returns a 200 (OK) response code with records for the specified products, represented as an array of CatalogProductInStock resources. For a description of properties defined for the CatalogProductInStock resource, see CatalogProductInStock.

GET Quantities by Product and Company

Use this request to retrieve quantity information for a specific product at a company.

Request

GET /Companies({CompanyId})/Entities({CompanyId})/CatalogProductQuantities({CatalogProductId})/Quantities

Example Request

GET /Companies(457549)/Entities(457549)/CatalogProductQuantities({CatalogProductId})/Quantities
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

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

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "8c57233d-25ec-4f59-a1c2-000017ba03de",
    "CompanyId": 457549,
    "EntityId": 459148,
    "IsSerialized": false,
    "IsDropShippable": false,
    "IsLot": false,
    "QuantityInStock": 0,
    "QuantityOnOrder": 0,
    "QuantityTransferIn": 0,
    "QuantityTransferOut": 0,
    "UnitId": 0
}

A successful request returns a 200 (OK) response code with quantities for the specified products, represented as a CatalogProductQuantities resource. For a description of properties defined for the CatalogProductQuantities resource, see CatalogProductQuantities.

GET Quantities by Product and Entity

Use this request to retrieve quantity information for a specific product at an entity.

Request

GET /Companies({CompanyId})/Entities({EntityId})/CatalogProductQuantities({CatalogProductId})/Quantities

Example Request

GET /Companies(457549)/Entities(459148)/CatalogProductQuantities({CatalogProductId})/Quantities
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

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

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "8c57233d-25ec-4f59-a1c2-000017ba03de",
    "CompanyId": 457549,
    "EntityId": 459148,
    "IsSerialized": false,
    "IsDropShippable": false,
    "IsLot": false,
    "QuantityInStock": 15,
    "QuantityOnOrder": 100,
    "QuantityTransferIn": 0,
    "QuantityTransferOut": 0,
    "UnitId": 0
}

A successful request returns a 200 (OK) response code with quantities for the specified products, represented as a CatalogProductQuantities resource. For a description of properties defined for the CatalogProductQuantities resource, see CatalogProductQuantities.

GET Quantities for All Products (Company)

Use this request to retrieve product quantity information for a company.

Request

GET /Companies({CompanyId})/Entities({CompanyId})/CatalogProductQuantities

Example Request

GET /Companies(457549)/Entities(457549)/CatalogProductQuantities
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

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

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "8c57233d-25ec-4f59-a1c2-000017ba03de",
        "CompanyId": 457549,
        "EntityId": 459148,
        "IsSerialized": false,
        "IsDropShippable": false,
        "IsLot": false,
        "QuantityInStock": 25,
        "QuantityOnOrder": 100,
        "QuantityTransferIn": 0,
        "QuantityTransferOut": 0,
        "UnitId": 0
    },
    {
        "Id": "49e5ccfc-0c21-40f3-a262-003913ae3d26",
        "CompanyId": 457549,
        "EntityId": 459148,
        "IsSerialized": false,
        "IsDropShippable": false,
        "IsLot": false,
        "QuantityInStock": 33,
        "QuantityOnOrder": 0,
        "QuantityTransferIn": 0,
        "QuantityTransferOut": 0,
        "UnitId": 0
    }
]

A successful request returns a 200 (OK) response code with quantities for all products, represented as an array of CatalogProductQuantities resources. For a description of properties defined for the CatalogProductQuantities resource, see CatalogProductQuantities.

GET Quantities for All Products (Entity)

Use this request to retrieve product quantity information for an entity.

Request

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

Example Request

GET /Companies(457549)/Entities(459148)/CatalogProductQuantities
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

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

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "8c57233d-25ec-4f59-a1c2-000017ba03de",
        "CompanyId": 457549,
        "EntityId": 459148,
        "IsSerialized": false,
        "IsDropShippable": false,
        "IsLot": false,
        "QuantityInStock": 25,
        "QuantityOnOrder": 100,
        "QuantityTransferIn": 0,
        "QuantityTransferOut": 0,
        "UnitId": 0
    },
    {
        "Id": "49e5ccfc-0c21-40f3-a262-003913ae3d26",
        "CompanyId": 457549,
        "EntityId": 459148,
        "IsSerialized": false,
        "IsDropShippable": false,
        "IsLot": false,
        "QuantityInStock": 33,
        "QuantityOnOrder": 0,
        "QuantityTransferIn": 0,
        "QuantityTransferOut": 0,
        "UnitId": 0
    }
]

A successful request returns a 200 (OK) response code with quantities for all products, represented as an array of CatalogProductQuantities resources. For a description of properties defined for the CatalogProductQuantities resource, see CatalogProductQuantities.

GET Detailed Product Quantities (Entity)

Use this request to retrieve detailed quantity information for a serialized product.

This request is only supported at the entity level; it is not supported at the company level.

Request

GET /Companies({CompanyId})/Entities({EntityId})/CatalogProductQuantitiesDetailed({SerializedProductId})

Example Request

GET /Companies(457549)/Entities(459148)/CatalogProductQuantitiesDetailed(144cb10a-66c7-4fb2-899e-c616a7f665d3)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of the entity.
SerializedProductId (GUID) The identifier of a serialized catalog product.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "SerialNumbers": [
        "A00000085AD33E"
    ],
    "Lots": [],
    "Id": "6ed12368-1586-4941-be37-2e4b146b7b96",
    "CompanyId": 457549,
    "EntityId": 459657,
    "IsSerialized": true,
    "IsDropShippable": null,
    "IsLot": false,
    "QuantityInStock": 1,
    "QuantityOnOrder": 0,
    "QuantityTransferIn": 0,
    "QuantityTransferOut": 0,
    "UnitId": 0
}

A successful request returns a 200 (OK) response code with quantities for the specified serialized product, represented as a CatalogProductQuantitiesDetailed resource. For a description of properties defined for the CatalogProductQuantitiesDetailed resource, see CatalogProductQuantitiesDetailed.

GET Summarized Quantities for a Product Across a Company

Use this request to retrieve summarized quantity information for a product at the company level.

Request

GET /Companies({CompanyId})/Entities({CompanyId})/CatalogProductQuantitiesSummarized({CatalogProductId})

Example Request

GET /Companies(457549)/Entities(457549)/CatalogProductQuantitiesSummarized(8c57233d-25ec-4f59-a1c2-000017ba03de)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
CatalogProductId (GUID) The identifier of the catalog product.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "8c57233d-25ec-4f59-a1c2-000017ba03de",
    "CompanyId": 457549,
    "EntityId": 457549,
    "IsSerialized": false,
    "IsDropShippable": false,
    "IsLot": false,
    "QuantityInStock": 0,
    "QuantityOnOrder": 0,
    "QuantityTransferIn": 0,
    "QuantityTransferOut": 0,
    "UnitId": 0
}

A successful request returns a 200 (OK) response code with quantities for the specified product, represented as a CatalogProductQuantities resource. For a description of properties defined for the CatalogProductQuantities resource, see CatalogProductQuantities.

GET Summarized Quantities for a Product (Entity)

Use this request to retrieve summarized quantity information for a product at the entity level.

Request

GET /Companies({CompanyId})/Entities({EntityId})/CatalogProductQuantitiesSummarized({CatalogProductId})

Example Request

GET /Companies(457549)/Entities(459148)/CatalogProductQuantitiesSummarized(8c57233d-25ec-4f59-a1c2-000017ba03de)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of the entity.
CatalogProductId (GUID) The identifier of the catalog product.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "8c57233d-25ec-4f59-a1c2-000017ba03de",
    "CompanyId": 457549,
    "EntityId": 457549,
    "IsSerialized": false,
    "IsDropShippable": false,
    "IsLot": false,
    "QuantityInStock": 0,
    "QuantityOnOrder": 0,
    "QuantityTransferIn": 0,
    "QuantityTransferOut": 0,
    "UnitId": 0
}

A successful request returns a 200 (OK) response code with quantities for the specified product, represented as a CatalogProductQuantities resource. For a description of properties defined for the CatalogProductQuantities resource, see CatalogProductQuantities.

GET Summarized Quantities for All Products (Company)

Use this request to retrieve summarized quantity information for all products at the company level.

Request

GET /Companies({CompanyId})/Entities({CompanyId})/CatalogProductQuantitiesSummarized

Example Request

GET /Companies(457549)/Entities(457549)/CatalogProductQuantitiesSummarized
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

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

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "8c57233d-25ec-4f59-a1c2-000017ba03de",
        "CompanyId": 457549,
        "EntityId": 457549,
        "IsSerialized": false,
        "IsDropShippable": false,
        "IsLot": false,
        "QuantityInStock": 25,
        "QuantityOnOrder": 0,
        "QuantityTransferIn": 0,
        "QuantityTransferOut": 0,
        "UnitId": 0
    },
    {
        "Id": "49e5ccfc-0c21-40f3-a262-003913ae3d26",
        "CompanyId": 457549,
        "EntityId": 457549,
        "IsSerialized": false,
        "IsDropShippable": false,
        "IsLot": false,
        "QuantityInStock": 300,
        "QuantityOnOrder": 0,
        "QuantityTransferIn": 0,
        "QuantityTransferOut": 0,
        "UnitId": 0
    }
]

A successful request returns a 200 (OK) response code with summarized quantities for all products for the company, represented as an array of CatalogProductQuantities resources. For a description of properties defined for the CatalogProductQuantities resource, see CatalogProductQuantities.

GET Summarized Quantities for All Products (Entity)

Use this request to retrieve summarized quantity information for all products at the entity level.

Request

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

Example Request

GET /Companies(457549)/Entities(459148)/CatalogProductQuantitiesSummarized
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

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

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "8c57233d-25ec-4f59-a1c2-000017ba03de",
        "CompanyId": 457549,
        "EntityId": 457549,
        "IsSerialized": false,
        "IsDropShippable": false,
        "IsLot": false,
        "QuantityInStock": 25,
        "QuantityOnOrder": 0,
        "QuantityTransferIn": 0,
        "QuantityTransferOut": 0,
        "UnitId": 0
    },
    {
        "Id": "49e5ccfc-0c21-40f3-a262-003913ae3d26",
        "CompanyId": 457549,
        "EntityId": 457549,
        "IsSerialized": false,
        "IsDropShippable": false,
        "IsLot": false,
        "QuantityInStock": 300,
        "QuantityOnOrder": 0,
        "QuantityTransferIn": 0,
        "QuantityTransferOut": 0,
        "UnitId": 0
    }
]

A successful request returns a 200 (OK) response code with summarized quantities for all products for the entity, represented as an array of CatalogProductQuantities resources. For a description of properties defined for the CatalogProductQuantities resource, see CatalogProductQuantities.

Add Serial Numbers to a Serialized Product

Use this request to add serial numbers–that is increase the number of products available–for a serialized product.

Request

POST /Companies({CompanyId})//Entities({EntityId})/CatalogItems({SerializedCatalogProductId})/SerialNumbers

Example Request

POST /Companies(457549)/Entities(459657)/CatalogItems(6ED12368-1586-4941-BE37-2E4B146B7B96)/SerialNumbers
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

{
  "Id": "SNT-6975",
  "CatalogProductId": "6ED12368-1586-4941-BE37-2E4B146B7B96",
  "EntityId": "459657",
  "CompanyId": "457549"
}

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of the entity.
SerializedCatalogProductId (GUID) The identifier of the serialized product in the iQmetrix Product Catalog.
SerialNumber (String) The serial number of the product being added.

Request Parameters

Name Description
Id (String) Required. The serial number or package identifier of the item.
CatalogProductId (GUID) Required. The identifier of the item in the iQmetrix Product Catalog.
EntityId (Integer) Required. The identifier of an entity, represented as a CompanyTreeNode.
CompanyId (Integer) Required. The identifier of the Company.

Response

Example Response

HTTP 201 Content-Type: application/json
{
  "Id": "SNT-6975",
  "CatalogProductId": "6ED12368-1586-4941-BE37-2E4B146B7B96",
  "EntityId": "459657",
  "CompanyId": "457549"
}

A successful request returns a 201 (Created) response with the added information represented as a SerialNumber resources. For a description of properties defined for the SerialNumber resource, see SerialNumber.

DELETE a Serial Number

Use this request to delete a serial number from a serialized product.

Request

DELETE /Companies({CompanyId})/Entities({EntityId})/CatalogItems({SerializedCatalogProductId})/SerialNumbers({SerialNumber})

Example Request

DELETE /Companies(457549)/Entities(459148)/CatalogItems(6ED12368-1586-4941-BE37-2E4B146B7B96)/SerialNumbers(SNT-6975)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of the entity.
SerializedCatalogProductId (GUID) The identifier of the serialized product in the iQmetrix Product Catalog.
SerialNumbers (String) The serial number being deleted.

Request Parameters

None.

Response

Example Response

HTTP 204 Content-Type: application/json

A successful request returns a 204 (No Content) response code.

GET Serial Numbers for a Serialized Product (Company)

Use this request to retrieve serial numbers for serialized products at the company level.

Request

GET /Companies({CompanyId})/CatalogItems({SerializedCatalogProductId})/SerialNumbers

Example Request

GET /Companies(457549)/CatalogItems(6ED12368-1586-4941-BE37-2E4B146B7B96)/SerialNumbers
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
SerializedCatalogProductId (GUID) The identifier of a serialized product in the iQmetrix Product Catalog.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "TXN-9982",
        "CatalogProductId": "6ed12368-1586-4941-be37-2e4b146b7b96",
        "EntityId": 459148,
        "CompanyId": 457549
    },
    {
        "Id": "TXN-9073",
        "CatalogProductId": "6ed12368-1586-4941-be37-2e4b146b7b96",
        "EntityId": 459148,
        "CompanyId": 457549
    }
]

A successful request returns a 200 (OK) response code with a list of serial numbers for the product, represented as an array of SerialNumber resources. For a description of properties defined for the SerialNumber resource, see SerialNumber.

GET Serial Numbers for a Serialized Product (Entity)

Use this request to retrieve serial numbers for serialized products at the entity level.

Request

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

Example Request

GET /Companies(457549)/Entities(459148)/CatalogItems(6ED12368-1586-4941-BE37-2E4B146B7B96)/SerialNumbers
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of the entity.
SerializedCatalogProductId (GUID) The identifier of a serialized product in the iQmetrix Product Catalog.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "TXN-9982",
        "CatalogProductId": "6ed12368-1586-4941-be37-2e4b146b7b96",
        "EntityId": 459148,
        "CompanyId": 457549
    },
    {
        "Id": "TXN-9073",
        "CatalogProductId": "6ed12368-1586-4941-be37-2e4b146b7b96",
        "EntityId": 459148,
        "CompanyId": 457549
    }
]

A successful request returns a 200 (OK) response code with a list of serial numbers for the product, represented as an array of SerialNumber resources. For a description of properties defined for the SerialNumber resource, see SerialNumber.

GET Information for a Specific Serial Number by Product

Use this request to retrieve the record for a given serial number for a catalog product.

Request

GET /Companies({CompanyId})/Entities({EntityId})/CatalogItems({SerializedCatalogProductId})/SerialNumbers({SerialNumber})

Example Request

GET /Companies(457549)/Entities(459148)/CatalogItems(6ED12368-1586-4941-BE37-2E4B146B7B96)/SerialNumbers(TXN-9982)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of the entity.
SerializedCatalogProductId (GUID) The identifier of a serialized product in the iQmetrix Product Catalog.
SerialNumber (String) An existing serial number for the product.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "TXN-9982",
    "CatalogProductId": "6ed12368-1586-4941-be37-2e4b146b7b96",
    "EntityId": 459148,
    "CompanyId": 457549
}

A successful request returns a 200 (OK) response code with information for the requested serial number, represented as a SerialNumber resource. For a description of properties defined for the SerialNumber resource, see SerialNumber.

GET Information for a Specific Serial Number by Entity

Use this request to retrieve the record for a given serial number at the entity level.

Request

GET /Companies({CompanyId})/Entities({EntityId})/SerialNumbers?$filter=Id eq '{SerialNumber}'

Example Request

GET /Companies(457549)/Entities(459148)/SerialNumbers?$filter=Id eq 'TXN-9982'
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the Company.
EntityId (Integer) The identifier of the entity.
SerialNumber (String) An existing serial number for the product.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "TXN-9982",
    "CatalogProductId": "6ed12368-1586-4941-be37-2e4b146b7b96",
    "EntityId": 459148,
    "CompanyId": 457549
}

A successful request returns a 200 (OK) response code with information for the requested serial number, represented as a SerialNumber resource. For a description of properties defined for the SerialNumber resource, see SerialNumber.

Add Supplier Availability

Use this request to create a new supplier availability record for a product.

Request

POST /Suppliers({SupplierId})/SupplierSkus

Example Request

POST /Suppliers(81553)/SupplierSkus
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

{
  "SupplierSku": "DD1234567890",
  "SupplierEntityId": 81553,
  "Quantity": 30,
  "IsAvailable": true
}

Path Parameters

Name Description
SupplierId (Integer) The identifier of the supplier.

Request Parameters

Name Description
SupplierSku (String) Required. The SKU used by this supplier for this item.
SupplierEntityId (Integer) Required. The identifier of the Supplier.
IsAvailable (Boolean) Required. Indicates whether the item is available.
Quantity (Integer) Required. The quantity of items available.

Response

Example Response

HTTP 201 Content-Type: application/json
{
    "Id": "38e76546-af1b-47bd-be2a-0ab14aabceaa",
    "SupplierSku": "M9273-V3",
    "SupplierEntityId": 81553,
    "IsAvailable": true,
    "Quantity": 10,
    "LastModifiedDateUtc": "2018-08-11T20:58:02.71"
}

A successful request returns a 201 (Created) response code with the new availability record, represented as a SupplierProductAvailability resource. For a description of properties defined for the SupplierProductAvailability resource, see SupplierProductAvailability.

Update Supplier Availability

Use this request to update an existing supplier availability record.

Request

PUT /Suppliers({SupplierId})/SupplierSkus({SupplierProductId})

Example Request

PUT /Suppliers(81553)/SupplierSkus(abaf70b9-218e-4301-bb52-3a50d881b985)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

{
  "Id": "abaf70b9-218e-4301-bb52-3a50d881b985",
  "SupplierSku": "DD1234567890",
  "SupplierEntityId": 81553,
  "Quantity": 30,
  "IsAvailable": true
}

Path Parameters

Name Description
SupplierId (Integer) The identifier of the supplier.
SupplierProductId (GUID) The identifier of a supplier availability record.

Request Parameters

Name Description
Id (GUID) Required. The identifier of the supplier SKU availability record.
SupplierSku (String) Required. The actual SKU used by this supplier for this item.
SupplierEntityId (Integer) Required. The identifier of the supplier.
IsAvailable (Boolean) Required. Indicates whether the item is available.
Quantity (Integer) Required. The quantity of items available.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "38e76546-af1b-47bd-be2a-0ab14aabceaa",
    "SupplierSku": "M9273-V3",
    "SupplierEntityId": 81553,
    "IsAvailable": true,
    "Quantity": 10,
    "LastModifiedDateUtc": "2018-08-11T20:58:02.71"
}

A successful request returns a 200 (OK) response code with the updated availability record, represented as a SupplierProductAvailability resource. For a description of properties defined for the SupplierProductAvailability resource, see SupplierProductAvailability.

DELETE Supplier Availability

Use this request to delete a supplier availability record.

Request

DELETE /Suppliers({SupplierId})/SupplierSkus({SupplierProductId})

Example Request

DELETE /Suppliers(81553)/SupplierSkus(abaf70b9-218e-4301-bb52-3a50d881b985)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
SupplierId (Integer) The identifier of the supplier.
SupplierProductId (GUID) The identifier of a supplier availability record.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json

A successful request returns a 200 (OK) response code.

GET Supplier Availability for All SKUs (Supplier)

Use this request to list availability for all product SKUs at a given supplier.

Both this request and the company-scoped version of the request return a collection of SupplierProductAvailability resources, but the requests are used differently.

This request, scoped for suppliers, is intended for suppliers to use to query the availability service for any of their availability information. Permissions for this endpoint are determined using the supplier identifier in the URI; the query will succeed only for suppliers with correct permissions.

Request

GET /Suppliers({SupplierId})/SupplierSkus

Example Request

GET /Suppliers(242418)/SupplierSkus
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
SupplierId (Integer) The identifier of the supplier.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "0429e0a4-605b-4048-9ec6-01cc8c0ce2f1",
        "SupplierSku": "M9276-V3",
        "SupplierEntityId": 81553,
        "IsAvailable": true,
        "Quantity": 90,
        "LastModifiedDateUtc": "2017-09-05T21:40:59.253"
    },
    {
        "Id": "582e80b3-0273-4d94-baee-04e3a8638a63",
        "SupplierSku": "M9278-V6",
        "SupplierEntityId": 81553,
        "IsAvailable": true,
        "Quantity": 88,
        "LastModifiedDateUtc": "2016-02-24T20:31:34.627"
    },
    {
        "Id": "ae24856a-17d2-4a34-b3cd-0aabf9e24183",
        "SupplierSku": "M9266",
        "SupplierEntityId": 81553,
        "IsAvailable": true,
        "Quantity": 99,
        "LastModifiedDateUtc": "2015-08-17T15:18:31.497"
    },
    {
        "Id": "38e76546-af1b-47bd-be2a-0ab14aabceaa",
        "SupplierSku": "M9273-V3",
        "SupplierEntityId": 81553,
        "IsAvailable": true,
        "Quantity": 10,
        "LastModifiedDateUtc": "2015-08-11T20:58:02.71"
    }
]

A successful request returns a 200 (OK) response code with a list of SKUs and their availability, represented as a SupplierProductAvailability resource. For a description of properties defined for the SupplierProductAvailability resource, see SupplierProductAvailability.

GET a Supplier Availability Record (Supplier)

Use this request to retrieve a supplier availability record by the record’s identifier.

Both this request and the company-scoped version of the request return a SupplierProductAvailability resource, but the requests are used differently.

This request, scoped for suppliers, will succeed only for suppliers with correct permissions.

Request

GET /Suppliers({SupplierId})/SupplierSkus({RecordId})

Example Request

GET /Suppliers(81553)/SupplierSkus(0429e0a4-605b-4048-9ec6-01cc8c0ce2f1)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
SupplierId (Integer) The identifier of the supplier.
RecordId (GUID) The identifier of the supplier availability record. (Note: This is the identifier of the record, not the SKU of the product.)

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "0429e0a4-605b-4048-9ec6-01cc8c0ce2f1",
    "SupplierSku": "M9276-V3",
    "SupplierEntityId": 81553,
    "IsAvailable": true,
    "Quantity": 90,
    "LastModifiedDateUtc": "2017-09-05T21:40:59.253"
}

A successful request returns a 200 (OK) response code with the availability record, represented as a SupplierProductAvailability resource. For a description of properties defined for the SupplierProductAvailability resource, see SupplierProductAvailability.

GET Supplier Availability for a SKU (Supplier)

Use this request to retrieve supplier availability for a product using the supplier SKU.

Both this request and the company-scoped version of the request return a SupplierProductAvailability resource, but the requests are used differently.

This request, scoped for suppliers, will succeed only for suppliers with correct permissions.

Request

GET /Suppliers({SupplierId})/SupplierSkus?$filter=SupplierSku eq '{SupplierSku}'

Example Request

GET /Suppliers(81553)/SupplierSkus?$filter=SupplierSku eq 'DD1234567891'
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
SupplierId (Integer) The identifier of the supplier.
SupplierSku (String) The supplier’s SKU for the product.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "0429e0a4-605b-4048-9ec6-01cc8c0ce2f1",
    "SupplierSku": "M9276-V3",
    "SupplierEntityId": 81553,
    "IsAvailable": true,
    "Quantity": 90,
    "LastModifiedDateUtc": "2017-09-05T21:40:59.253"
}

A successful request returns a 200 (OK) response code with the availability record, represented as a SupplierProductAvailability resource. For a description of properties defined for the SupplierProductAvailability resource, see SupplierProductAvailability.

GET Supplier Availability for All SKUs (Company)

Use this request to list availability for all product SKUs at a given supplier, scoped for a given company.

Both this request and the supplier-scoped version of this request return a collection of SupplierProductAvailability resources, but the requests are used differently.

This request is intended for client companies to use to query the availability service for supplier availability to their own company. Permissions for this endpoint are determined using the Company identifier in the URI; the query will show only availability for the specified company.

Request

GET /Suppliers({SupplierId})/Companies({CompanyId})/SupplierSkus

Example Request

GET /Suppliers(242418)/Companies(99225)/SupplierSkus
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
SupplierId (Integer) The identifier of the supplier.
CompanyId (Integer) The identifier of the company.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "0429e0a4-605b-4048-9ec6-01cc8c0ce2f1",
        "SupplierSku": "M9276-V3",
        "SupplierEntityId": 81553,
        "IsAvailable": true,
        "Quantity": 90,
        "LastModifiedDateUtc": "2017-09-05T21:40:59.253"
    },
    {
        "Id": "582e80b3-0273-4d94-baee-04e3a8638a63",
        "SupplierSku": "M9278-V6",
        "SupplierEntityId": 81553,
        "IsAvailable": true,
        "Quantity": 88,
        "LastModifiedDateUtc": "2016-02-24T20:31:34.627"
    },
    {
        "Id": "ae24856a-17d2-4a34-b3cd-0aabf9e24183",
        "SupplierSku": "M9266",
        "SupplierEntityId": 81553,
        "IsAvailable": true,
        "Quantity": 99,
        "LastModifiedDateUtc": "2015-08-17T15:18:31.497"
    },
    {
        "Id": "38e76546-af1b-47bd-be2a-0ab14aabceaa",
        "SupplierSku": "M9273-V3",
        "SupplierEntityId": 81553,
        "IsAvailable": true,
        "Quantity": 10,
        "LastModifiedDateUtc": "2015-08-11T20:58:02.71"
    }
]

A successful request returns a 200 (OK) response code with a list of SKUs and their availability, represented as a SupplierProductAvailability resource. For a description of properties defined for the SupplierProductAvailability resource, see SupplierProductAvailability.

GET a Supplier Availability Record (Company)

Use this request to retrieve a supplier availability record by the record’s identifier.

Both this request and the supplier-scoped version of the request return a SupplierProductAvailability resource, but the requests are used differently.

This request, scoped for a company inquiring about supplier availability, will succeed only for requests with correct company credentials.

Request

GET /Suppliers({SupplierId})/Companies({CompanyId})/SupplierSkus({RecordId})

Example Request

GET /Suppliers(81553)/Companies(457549)/SupplierSkus(0429e0a4-605b-4048-9ec6-01cc8c0ce2f1)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
SupplierId (Integer) The identifier of the supplier.
CompanyId (Integer) The identifier of the company.
RecordId (GUID) The identifier of the supplier availability record. (Note: This is the identifier of the record, not the SKU of the product.)

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "0429e0a4-605b-4048-9ec6-01cc8c0ce2f1",
    "SupplierSku": "M9276-V3",
    "SupplierEntityId": 81553,
    "IsAvailable": true,
    "Quantity": 90,
    "LastModifiedDateUtc": "2017-09-05T21:40:59.253"
}

A successful request returns a 200 (OK) response code with the availability record, represented as a SupplierProductAvailability resource. For a description of properties defined for the SupplierProductAvailability resource, see SupplierProductAvailability.

GET Supplier Availability for a SKU (Company)

Use this request to retrieve supplier availability for a product using the supplier SKU.

Both this request and the supplier-scoped version of the request return a SupplierProductAvailability resource, but the requests are used differently.

This request, scoped for a company inquiring about supplier availability, will succeed only for requests with correct company credentials.

Request

GET /Suppliers({SupplierId})/Companies({CompanyId})/SupplierSkus?$filter=SupplierSku eq '{SupplierSku}'

Example Request

GET /Suppliers(81553)/Companies(457549)/SupplierSkus?$filter=SupplierSku eq 'DD1234567891'
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
SupplierId (Integer) The identifier of the supplier.
CompanyId (Integer) The identifier of the company.
SupplierSku (String) The supplier’s SKU for the product.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "0429e0a4-605b-4048-9ec6-01cc8c0ce2f1",
    "SupplierSku": "M9276-V3",
    "SupplierEntityId": 81553,
    "IsAvailable": true,
    "Quantity": 90,
    "LastModifiedDateUtc": "2017-09-05T21:40:59.253"
}

A successful request returns a 200 (OK) response code with the availability record, represented as a SupplierProductAvailability resource. For a description of properties defined for the SupplierProductAvailability resource, see SupplierProductAvailability.

Retrieve Supplier Availability for Multiple Products by SKU (Company)

Use this request to retrieve supplier product availability records for multiple SKUs. Although this request is a POST, it performs like a GET; it does not create or change any data.

Request

POST /Suppliers({SupplierId})/Companies({CompanyId})/BulkSupplierAvailability

Example Request

POST /Suppliers(81553)/Companies(336288)/BulkSupplierAvailability
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

{
    "SupplierAvailabilities": [
        {
            "SupplierSku": "M9276-V3"
        },
        {
            "SupplierSku": "M9278-V6"
        }
    ]
}

Path Parameters

Name Description
SupplierId (Integer) The identifier of the supplier.
CompanyId (Integer) The identifier of the company.

Request Parameters

Name Description
SupplierAvailabilities Array[SupplierSku] Required. An array of the supplier SKUs you want information for.

Response

Example Response

HTTP 200 Content-Type: application/json

{
    "Id": "90b5c513-0010-4b79-93cc-5f5b22b0665b",
    "SupplierAvailabilities": [
        {
            "Id": "0429e0a4-605b-4048-9ec6-01cc8c0ce2f1",
            "SupplierSku": "M9276-V3",
            "SupplierEntityId": 81553,
            "IsAvailable": true,
            "Quantity": 90,
            "LastModifiedDateUtc": "2017-09-05T21:40:59.253"
        },
        {
            "Id": "582e80b3-0273-4d94-baee-04e3a8638a63",
            "SupplierSku": "M9278-V6",
            "SupplierEntityId": 81553,
            "IsAvailable": true,
            "Quantity": 88,
            "LastModifiedDateUtc": "2016-02-24T20:31:34.627"
        }
    ]
}

A successful request returns a 200 (OK) response code with the supplier availability records for the requested SKUs, represented as a collection of SupplierProductAvailability resources. For a description of properties defined for the SupplierProductAvailability resource, see SupplierProductAvailability. The response includes a generated identifier, which can be ignored.

GET Lot Information for a Product (Company)

Use this request to retrieve lot information at the company level for products that are supplied in lots.

Request

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

Example Request

GET /Companies(15725)/CatalogItems(1D5068B4-0DFE-466D-826A-25835C14F50E)/Lots
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the company.
CatalogItemId (GUID) The identifier of a product that is supplied in lots.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "21",
        "CatalogProductId": "1d5068b4-0dfe-466d-826a-25835c14f50e",
        "CompanyId": 15725,
        "EntityId": 195202,
        "Packages": [
            {
                "PackageId": "12",
                "Quantity": 13000
            }
        ]
    },
    {
        "Id": "23",
        "CatalogProductId": "1d5068b4-0dfe-466d-826a-25835c14f50e",
        "CompanyId": 15725,
        "EntityId": 195202,
        "Packages": [
            {
                "PackageId": "12",
                "Quantity": 43000
            },
            {
                "PackageId": "563",
                "Quantity": 50500
            },
            {
                "PackageId": "564",
                "Quantity": 50000
            }
        ]
    }
]

A successful request returns a 200 (OK) response code with a list of the lots available for the product, represented as an array of Lot resources. For a description of properties defined for the Lot resource, see Lot.

GET Lot Information for a Product (Entity)

Use this request to retrieve lot information at the entity level for products that are supplied in lots.

Request

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

Example Request

GET /Companies(15725)/Entities(15726)/CatalogItems(1D5068B4-0DFE-466D-826A-25835C14F50E)/Lots
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the company.
EntityId (Integer) The identifier of the entity.
CatalogItemId (GUID) The identifier of a product that is supplied in lots.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "25",
        "CatalogProductId": "1d5068b4-0dfe-466d-826a-25835c14f50e",
        "CompanyId": 15725,
        "EntityId": 15726,
        "Packages": [
            {
                "PackageId": "5666",
                "Quantity": 2000
            }
        ]
    },
    {
        "Id": "RB2",
        "CatalogProductId": "1d5068b4-0dfe-466d-826a-25835c14f50e",
        "CompanyId": 15725,
        "EntityId": 15726,
        "Packages": [
            {
                "PackageId": "RB91695717",
                "Quantity": 144001
            }
        ]
    }
]

A successful request returns a 200 (OK) response code with a list of the lots available for the product, represented as an array of Lot resources. For a description of properties defined for the Lot resource, see Lot.

GET Information for a Specific Lot

Use this request to retrieve information for a specific lot.

Request

GET /Companies({CompanyId})/Entities{EntityId}/CatalogItems({CatalogItemId})/Lots({LotId})

Example Request

GET /Companies(15725)/Entities(15726)/CatalogItems(1D5068B4-0DFE-466D-826A-25835C14F50E)/Lots(RB2)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the company.
EntityId (Integer) The identifier of the entity.
CatalogItemId (GUID) The identifier of a product that is supplied in lots.
LotId (String) The identifier of the lot.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "RB2",
    "CatalogProductId": "1d5068b4-0dfe-466d-826a-25835c14f50e",
    "CompanyId": 15725,
    "EntityId": 15726,
    "Packages": [
        {
            "PackageId": "RB91695717",
            "Quantity": 144001
        }
    ]
}

A successful request returns a 200 (OK) response code with information for the requested lot, represented as a Lot resource. For a description of properties defined for the Lot resource, see Lot.

Set an Availability Threshold

Use this request to set a threshold for minimum product availability.

Request

POST /Companies({CompanyId})/Entities({EntityId})/AvailabilityThreshold

Example Request

POST /Companies(336288)/Entities(459148)/AvailabilityThreshold
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

{
  "CompanyId" : 336288,
  "EntityId" : 459148,
  "MinQuantity": 10,
  "ProductId": "8C57233D-25EC-4F59-A1C2-000017BA03DE"
}

Path Parameters

Name Description
CompanyId (Integer) The identifier of the company.
EntityId (Integer) The identifier of the entity. If you want to set the threshold at the company level, re-use CompanyId here.

Request Parameters

Name Description
CompanyId (Integer) Required. The identifier of the company.
EntityId (Integer) Required. The identifier of the entity.
MinQuantity (Integer) Required. The minimum quantity threshold being set for this item.
ProductId (GUID) Required. The iQmetrix Product Catalog identifier of the item to which the threshold applies.

Response

Example Response

HTTP 201 Content-Type: application/json

{
    "Id": "a044ca19-47de-49b5-ae07-df324d8b6544",
    "ProductId": "8c57233d-25ec-4f59-a1c2-000017ba03de",
    "CompanyId": 336288,
    "EntityId": 459148,
    "UnitId": 0,
    "MinQuantity": 10
}

A successful request returns a 201 (Created) response code with the new threshold record, represented as a AvailabilityThreshold resource. For a description of properties defined for the AvailabilityThreshold resource, see AvailabilityThreshold.

Update a Threshold by Product

Use this request to update a minimum availability threshold for a product. This request can also be used to create a new threshold.

Request

POST /Companies({CompanyId})/Entities({EntityId})/Products({CatalogProductId})/AvailabilityThreshold

Example Request

POST /Companies(336288)/Entities(459148)/Products(8C57233D-25EC-4F59-A1C2-000017BA03DE)/AvailabilityThreshold
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

{
  "CompanyId" : 336288,
  "EntityId" : 459148,
  "MinQuantity": 10,
  "ProductId": "8C57233D-25EC-4F59-A1C2-000017BA03DE"
}

Path Parameters

Name Description
CompanyId (Integer) The identifier of the company.
EntityId (Integer) The identifier of the entity. If you want to set the threshold at the company level, use CompanyId here.
CatalogProductId (GUID) The identifier of the item in the iQmetrix Product Catalog.

Request Parameters

Name Description
CompanyId (Integer) Required. The identifier of the company.
EntityId (Integer) Required. The identifier of the entity.
MinQuantity (Integer) Required. The minimum quantity threshold being set for this item.
ProductId (GUID) Required. The iQmetrix Product Catalog identifier of the item to which the threshold applies.

Response

Example Response

HTTP 201 Content-Type: application/json

{
    "Id": 0,
    "ProductId": "8c57233d-25ec-4f59-a1c2-000017ba03de",
    "CompanyId": 336288,
    "EntityId": 459148,
    "UnitId": 0,
    "MinQuantity": 53
}

A successful request returns a 201 (Created) response code with the new or updated threshold record, represented as a AvailabilityThreshold resource. For a description of properties defined for the AvailabilityThreshold resource, see AvailabilityThreshold.

DELETE a Threshold for a Product

Use this request to delete a product availability threshold.

Request

DELETE /Companies({CompanyId})/Entities({EntityId})/Products({CatalogProductId})/AvailabilityThreshold

Example Request

DELETE /Companies(336288)/Entities(459148)/Products(8C57233D-25EC-4F59-A1C2-000017BA03DE)/AvailabilityThreshold
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

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

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json

A successful request returns a 200 (OK) response.

GET Thresholds for an Entity

Use this request to retrieve information about availability thresholds configured for an entity.

Request

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

Example Request

GET /Companies(336288)/Entities(459148)/AvailabilityThreshold
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the company.
EntityId (Integer) The identifier of the entity.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json

[
    {
        "Id": "a044ca19-47de-49b5-ae07-df324d8b6544",
        "ProductId": "8c57233d-25ec-4f59-a1c2-000017ba03de",
        "CompanyId": 336288,
        "EntityId": 459148,
        "UnitId": 0,
        "MinQuantity": 53
    },
    {
        "Id": "64ab5127-b4a2-41e2-b07a-5be3f4261ec6",
        "ProductId": "7be1abe6-5f97-4527-97e4-3b3853e13c26",
        "EntityId": 459148,
        "UnitId": 0,
        "MinQuantity": 53
    }
]

A successful request returns a 200 (OK) response code with a list of the thresholds configured for the requested entity, represented as an array of AvailabilityThreshold resources. For a description of properties defined for the AvailabilityThreshold resource, see AvailabilityThreshold.

GET a Threshold for a Product

Use this request to retrieve threshold information for a product.

Request

GET /Companies({CompanyId})/Entities({EntityId})/Products({CatalogProductId})/AvailabilityThreshold

Example Request

GET /Companies(336288)/Entities(459148)/Products(8C57233D-25EC-4F59-A1C2-000017BA03DE)/AvailabilityThreshold
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the company.
EntityId (Integer) The identifier of the entity.
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": 0,
    "ProductId": "8c57233d-25ec-4f59-a1c2-000017ba03de",
    "CompanyId": 336288,
    "EntityId": 459148,
    "UnitId": 0,
    "MinQuantity": 53
}

A successful request returns a 200 (OK) response code with the threshold information, represented as a AvailabilityThreshold resource. For a description of properties defined for the AvailabilityThreshold resource, see AvailabilityThreshold.

GET Minimum Availability Below Threshold for a Supplier

Use this request to retrieve the thresholds configured for a supplier.

Request

GET /Companies({CompanyId})/Entities({EntityId})/Suppliers({SupplierId})/AvailabilityBelowThreshold

Example Request

GET /Companies(336288)/Entities(459148)/Suppliers(81553)/AvailabilityBelowThreshold
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the company.
EntityId (Integer) The identifier of the entity.
SupplierId (Integer) The identifier of the supplier.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json

{
    "Id": "8c9a6f0f-4725-40d3-be72-9b6c02313991",
    "CompanyId": 14146,
    "EntityId": 14202,
    "ProductId": "3b495ace-8063-43e6-99fc-7809495931cc",
    "Quantity": 3,
    "QuantityOnOrder": 25,
    "QuantityInTransfer": 0,
    "MinQuantity": 10
}

A successful request returns a 200 (OK) response code with the availability below minimum threshold information, represented as a AvailabilityBelowThreshold resource. For a description of properties defined for the AvailabilityBelowThreshold resource, see AvailabilityBelowThreshold.

Put Products on Hold

Use this request to put one or more products on hold. You can provide an identifier for the hold batch or allow the system to generate one.

Request

POST /Companies()/ProductHoldBatch

Example Request

When you put products on hold, you can provide the hold batch identifier or omit it. This example omits the identifier. If you omit the batch identifier, the system generates a GUID to identify the batch and returns it in the response.

POST /Companies(99225)/ProductHoldBatch
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

{
	"EntityId": 99225,
	"HoldDurationInMinutes": 60,
	"Products": [\{
		"CatalogProductId": "BF8B98F7-9C7A-4D09-A9D3-81A2544FBE13",
		"Quantity": 1
	},
	{
		"CatalogProductId": "32C2860E-C450-4776-A1E6-F1A78BE09AFC",
		"Quantity": 220
	}]
}

Path Parameters

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

Request Parameters

Name Description
Id (GUID) Optional. The identifier of the hold batch. You can specify this identifier as input; alternatively, you can allow the system to generate a GUID for the hold batch.
EntityId (Integer) Required. The identifier of the entity associated with this product hold.
HoldDurationInMinutes (DateTime) Required. The time at which this hold will expire. Must be greater than zero.
Products Array[ProductHold] Required. A list of the products on hold in this hold batch. There must be at least one product in the hold batch; otherwise, the API returns an HTTP 400 (“Bad Request”) response.

Response

Example Response

HTTP 200 Content-Type: application/json

{
	"Id": "A85905EF-DA40-4A5D-B1A3-F7877A4AF429",
	"EntityId": "",
	"HoldDurationInMinutes": 60,
	
	"Products": [
        {
		    "CatalogProductId": "BF8B98F7-9C7A-4D09-A9D3-81A2544FBE13",
		    "Quantity": 1
	    },
	    {
		"CatalogProductId": "32C2860E-C450-4776-A1E6-F1A78BE09AFC",
		"Quantity": 220
	    }
    ]
}

A successful request returns a 200 (OK) response code with information for the hold batch, represented as a CatalogProductHoldBatch resource. The response includes the generated identifier if none was provided as input. For a description of properties defined for the CatalogProductHoldBatch resource, see CatalogProductHoldBatch.

GET Information for a Hold Batch

Use this request to view information about a given hold batch.

Request

GET /Companies()/ProductHoldBatch({HoldBatchId})

Example Request

GET /Companies(91246)/ProductHoldBatch(A85905EF-DA40-4A5D-B1A3-F7877A4AF429)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the company.
HoldBatchId (GUID) The identifier of the hold batch.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
	"EntityId": "91252",
	"HoldDurationInMinutes": 60,
	
	"Products": [
        {
		    "CatalogProductId": "BF8B98F7-9C7A-4D09-A9D3-81A2544FBE13",
		    "Quantity": 22
	    },
	    {
		    "CatalogProductId": "32C2860E-C450-4776-A1E6-F1A78BE09AFC",
		    "Quantity": 44
	    },
	    {
		    "CatalogProductId": "32C2860E-C450-4776-A1E6-F1A78BE09AFC",
		    "Quantity": 77
	    }
    ]
}

A successful request returns a 200 (OK) response code with the hold batch information, represented as a CatalogProductHoldBatch resource. For a description of properties defined for the CatalogProductHoldBatch resource, see CatalogProductHoldBatch.

GET All Holds for an Entity and Product

Use this request to view information on holds for a given entity/product combination.

To control how information is returned, use pagination controls.

Request

GET /Companies()/Entities({EntityId})/CatalogItems({CatalogProductId})/ProductHolds

Example Request

GET /Companies(91246)/Entities(91252)/CatalogItems(BF8B98F7-9C7A-4D09-A9D3-81A2544FBE13)/ProductHolds?$skip=0&$top=50
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the company.
EntityId (Integer) The identifier of an entity, represented as a CompanyTreeNode. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a 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
{
	"EntityId": "91252",
	"HoldDurationInMinutes": 60,
	"ExpiresAtUtc": "2018-06-08T22:38:19",
	"Products": [
        {
		    "CatalogProductId": "BF8B98F7-9C7A-4D09-A9D3-81A2544FBE13",
		    "Quantity": 22
	    },
	    {
		    "CatalogProductId": "32C2860E-C450-4776-A1E6-F1A78BE09AFC",
		    "Quantity": 44
	    },
	    {
		    "CatalogProductId": "32C2860E-C450-4776-A1E6-F1A78BE09AFC",
		    "Quantity": 77
	    }
    ]
}

A successful request returns a 200 (OK) response code with the hold batch information, represented as a CatalogProductHoldBatch resource. For a description of properties defined for the CatalogProductHoldBatch resource, see CatalogProductHoldBatch.

DELETE a Hold Batch

Use this request to delete a given hold batch.

Request

DE:ETE /Companies()/ProductHoldBatch({HoldBatchId})

Example Request

DELETE /Companies(91246)/ProductHoldBatch(A85905EF-DA40-4A5D-B1A3-F7877A4AF429)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the company.
HoldBatchId (GUID) The identifier of the hold batch.

Request Parameters

None.

Response

Example Response

HTTP 204 Content-Type: application/json

A successful request returns a 204 (No Content) response code.

Commit (Reserve) Products in Inventory

Use this request to ensure that products placed on hold are correctly reserved in inventory (not sold in-store) until customers have had a chance to pick them up. You can provide an identifier for the hold batch or allow the system to generate one.

Request

POST /Companies()/ProductCommits

Example Request

When you commit products, you can provide the commit identifier or omit it. This example omits the identifier. If you omit the commit identifier, the system generates a GUID to identify the commit and returns it in the response.

POST /Companies(99225)/ProductCommit
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

{
  "CatalogProductId": "E555108C-CA19-4669-972A-A45C0EAB0D92",
  "EntityId": "",
  "Quantity": 1
}

Path Parameters

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

Request Parameters

Name Description
Id (GUID) Optional. An identifier for the product commit. You can specify this identifier as input; alternatively, you can allow the system to generate a GUID for the commit.
EntityId (Integer) Required. The identifier of the entity associated with committing this product. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a company.
CatalogProductId (GUID) Required. The catalog identifier of the product being committed.
Quantity (Integer) Required. The quantity of product to commit.

Response

Example Response

HTTP 200 Content-Type: application/json

{
  "Id": "CF0EBCC9-3C47-46D5-8AC0-0C7BBEA05886",
  "CatalogProductId": "E555108C-CA19-4669-972A-A45C0EAB0D92",
  "EntityId": "",
  "Quantity": 1
}

A successful request returns a 200 (OK) response code with the product commit information, represented as a CatalogProductCommit resource. The response includes a generated identifier if none was provided. For a description of properties defined for the CatalogProductCommit resource, see CatalogProductCommit.

GET Information for a Product Commit

Use this request to view information about a given product commit.

Request

GET /Companies()/ProductCommits({CommitId})

Example Request

GET /Companies(91246)/ProductCommits(CF0EBCC9-3C47-46D5-8AC0-0C7BBEA05886)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the company.
CommitId (GUID) The identifier of the product commit.

Request Parameters

None.

Response

Example Response

HTTP 200 Content-Type: application/json
{
  "Id": "CF0EBCC9-3C47-46D5-8AC0-0C7BBEA05886",
  "CatalogProductId": "E555108C-CA19-4669-972A-A45C0EAB0D92",
  "EntityId": "91252",
  "Quantity": 1
}

A successful request returns a 200 (OK) response code with the product commit information, represented as a CatalogProductCommit resource. For a description of properties defined for the CatalogProductCommit resource, see CatalogProductCommit.

GET All Product Commits for an Entity and Product

Use this request to view information about product commits for a given entity/product combination.

To control how information is returned, use pagination controls.

Request

GET /Companies()/Entities({EntityId})/CatalogItems({CatalogProductId})/ProductCommits

Example Request

GET /Companies(91246)/Entities(91252)/CatalogItems(BF8B98F7-9C7A-4D09-A9D3-81A2544FBE13)/ProductCommits?$skip=0&$top=50
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the company.
EntityId (Integer) The identifier of an entity, represented as a CompanyTreeNode. The entity identifier can be the same as the company identifier, or it can be different–for example, to represent a specific store within a 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": "CF0EBCC9-3C47-46D5-8AC0-0C7BBEA05886",
        "CatalogProductId": "E555108C-CA19-4669-972A-A45C0EAB0D92",
        "EntityId": "91246",
        "Quantity": 1
    }
]

A successful request returns a 200 (OK) response code with a list of the product commits in effect for the specified entity and product, represented as a CatalogProductCommit resource. For a description of properties defined for the CatalogProductCommit resource, see CatalogProductCommit.

DELETE a Product Commit

Use this request to delete a given product commit.

Request

DELETE /Companies()/ProductCommits({CommitId})

Example Request

DELETE /Companies(91246)/ProductCommits(1eed68ab-1748-4b1b-8737-43aa8764a4a4)
Authorization: Bearer d24zZnduM2Z2NjNmd_0DZndvQCxBLFwrJhx6FgY7QzIRCAcpBiJrKyElXRAwDXdROAJ-FDUgSTc_PmorRyZUBy8PclQNNgMxDz5q
Accept: application/json

Path Parameters

Name Description
CompanyId (Integer) The identifier of the company.
CommitId (GUID) The identifier of the product commit.

Request Parameters

None.

Response

Example Response

HTTP 204 Content-Type: application/json

A successful request returns a 204 (No Content) response code.

PAGINATION

Pagination in the User Manager API is controlled by the $skip and $top query string parameters.

RELEASE NOTES

1.14.0

Release Date: 24-05-2018

NEW
Support for Committed Inventory
When products are put on hold, there needs to be a mechanism to ensure that product that has been added to a sales order but not removed from the store (for example, because it has been purchased online) is not sold in-store before the online customer has had a chance to pick it up. This release adds the /ProductCommits endpoint for designating inventory as committed.

  • Create and delete commits: Companies({companyId})/ProductCommits({id})
  • Query commits by entity and product: Companies({companyId})/Entities({EntityId})/CatalogItems({CatalogProductId})/ProductCommits

1.13.0

Release Date: 24-05-2018

NEW
Ability to Place Products on Hold
Products that are purchased online need a mechanism for ensuring the products are reserved, not shown as available for purchase in store before the sales order has been created in RQ. Placing a product on hold reserves the inventory for online orders between the time the order is placed online and the time the sales order is created in RQ. To support this feature, this release introduces the /ProductHoldBatch and /ProductHolds endpoints.

  • Create, delete, and query product holds: Companies({companyId})/ProductHoldBatch({id})
  • Query holds by entity and product: Companies({companyId})/Entities({entityId})/CatalogItems({catalogProductId})/ProductHolds

1.12.0

Release Date: 04-05-2018

NEW
LastModifiedDateUtc Field in SupplierProductAvailability Resource
The LastModifiedDateUtc records the most recent update to supplier product availability information. You can query for this field to determine availability updates since a given date/time–ensuring downstream systems have the correct information.
You can query for the new field on the SupplierSkus endpoints, scoped either for suppliers or for customer companies, as in the following examples:
  • GET Suppliers({SupplierId})/SupplierSkus?$filter=LastModifiedDateUtc ge datetime'2018-04-01'
  • GET Suppliers({SupplierId})/SupplierSkus?$filter=LastModifiedDateUtc ge datetime'2018-04-01'
Either query returns a list of the records modified since the provided date/time.

The only supported query operator is ge.
Was this page helpful?