Inventory


The inventory services below provide the ability to manage virtual inventory listings within Quipt. Click here for a few use cases using the inventory services.

Download our postman collection to see how the endpoints can be used.

Get Virtual Inventory By Merchant

This service allows a partner to retrieve a paged list of virtual inventory items currently listed by a specific merchant.

URLhttps://api.getquipt.com/v2/inventory/virtual/{merchantId}/{pageSize}/{pageNumber}
 
Methodget

Parameters:

Name Description Type Required
{merchantId} Quipt Id or Partner Reference Number as defined in partner settings. String Yes
{pageSize} The maximum number of records to return. The maximum value is 200. Int Yes
{pageNumber} The page to retrieve. String No
&catalogStatus A comma separated list of statuses (0 = New, 10 = Received, 20 = Accepted, 30 = Rejected, 40 = Published). String No
&inventoryStatus A comma separated list of statuses (0 = New, 10 = Received, 20 = Accepted, 30 = Rejected; Does not exist, 31 = Rejected; Unauthorized, 32 = Rejected; already mapped, 33 = Rejected Unknown). String No
&include A comma separated list of properties to include with result. Valid options are Catalog, Details, Comments, Report, Freight, Properties. String No

Response Definitions:

Name Description Type
Paging Paging information for the records returned. Paging
Result The collection of inventory results. InventoryVirtualResult[]
TransactionId The transaction id for the request. String
TransactionTime The time the transaction took place. DateTime
Success Whether or not the transaction was successful. Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]

Get Virtual Inventory By Vendor And SKU

This services allows a partner to retrieve a specific listing they created by sku number.

URLhttps://api.getquipt.com/v2/inventory/virtual/{merchantId}/sku/{sku}
 
Methodget

Parameters:

Name Description Type Required
{merchantId} Quipt Id or Partner Reference Number as defined in partner settings. String Yes
{sku} The sku to retrieve. String No
&include A comma separated list of properties to include with result. Valid options are Catalog, Details, Comments, Report, Freight, Properties. String No

Response Definitions:

Name Description Type
Result The inventory virtual result. InventoryVirtualResult

Get Virtual Inventory By Id

This services allows a partner to retrieve a specific listing they created by the Quipt identifier.

URLhttps://api.getquipt.com/v2/inventory/virtual/id/{id}
 
Methodget

Parameters:

Name Description Type Required
{id} The id value assigned to an virtual inventory item. String Yes
&include A comma separated list of properties to include with result. Valid options are Catalog, Details, Comments, Report, Freight, Properties. String No

Response Definitions:

Name Description Type
Result The virtual inventory result. InventoryVirtualResult

Acknowledge

This service allows a partner to create and update inventory items.

URLhttps://api.getquipt.com/v2/inventory/virtual/acknowledge
 
Methodpost

Body Definitions:

Name Description Type
Items The inventory items to create or update. InventoryVirtual[]
TransactionId The transaction id for the request. String

Response Definitions:

Name Description Type
ReportId The id used to lookup report details using the report endpoint. Guid
RecordsReceived The number of records received. Int
TransactionId The transaction id for the request. String
TransactionTime The time the transaction took place. DateTime
Success Whether or not the transaction was successful Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]

Batch Report

This service allows a partner to retrieve the detailed report generated when the ‘Acknowledge’ service is used. The result of ‘Acknowledge’ returns the {id} used to retrieve the report from this service.

URLhttps://api.getquipt.com/v2/inventory/virtual/report/{id}/{pageSize}/{pageNumber}
 
Methodget

Parameters:

Name Description Type Required
{pageSize} The maximum number of records to return. The maximum value is 200. Int Yes
{pageNumber} The page to retrieve. String No
{id} The report identifier. Guid Yes
&includeLines Flag whether or not to include the line details. Boolean No

Response Definitions:

Name Description Type
Result The collection of inventory reports. InventoryVirtual Report[]
ReportId The report id. Guid
ReportTime The time the report was generated. DateTime
ReportStatus The current status of the report. Int
Paging Paging information for the records returned. Paging
TransactionId The transaction id for the request. String
TransactionTime The time the transaction took place. DateTime
Success Whether or not the transaction was successful. Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]

Inventory


The inventory services below provide the ability to manage virtual inventory listings within Quipt. Click here for a few use cases using the inventory services.

Download our postman collection to see how the endpoints can be used.

Get Virtual Inventory By Merchant

This service allows a partner to retrieve a paged list of virtual inventory items currently listed by a specific merchant.

URLhttps://api.getquipt.com/v2/inventory/virtual/{merchantId}/{pageSize}/{pageNumber}
 
Methodget

Parameters:

Name Description Type Required
{merchantId} Quipt Id or Partner Reference Number as defined in partner settings. String Yes
{pageSize} The maximum number of records to return. The maximum value is 200. Int Yes
{pageNumber} The page to retrieve. String No
&catalogStatus A comma separated list of statuses (0 = New, 10 = Received, 20 = Accepted, 30 = Rejected, 40 = Published). String No
&inventoryStatus A comma separated list of statuses (0 = New, 10 = Received, 20 = Accepted, 30 = Rejected; Does not exist, 31 = Rejected; Unauthorized, 32 = Rejected; already mapped, 33 = Rejected Unknown). String No
&include A comma separated list of properties to include with result. Valid options are Catalog, Details, Comments, Report, Freight, Properties. String No

Response Definitions:

Name Description Type
Paging Paging information for the records returned. Paging
Result The collection of inventory results. InventoryVirtualResult[]
TransactionId The transaction id for the request. String
TransactionTime The time the transaction took place. DateTime
Success Whether or not the transaction was successful. Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]

Get Virtual Inventory By Vendor And SKU

This services allows a partner to retrieve a specific listing they created by sku number.

URLhttps://api.getquipt.com/v2/inventory/virtual/{merchantId}/sku/{sku}
 
Methodget

Parameters:

Name Description Type Required
{merchantId} Quipt Id or Partner Reference Number as defined in partner settings. String Yes
{sku} The sku to retrieve. String No
&include A comma separated list of properties to include with result. Valid options are Catalog, Details, Comments, Report, Freight, Properties. String No

Response Definitions:

Name Description Type
Result The inventory virtual result. InventoryVirtualResult

Get Virtual Inventory By Id

This services allows a partner to retrieve a specific listing they created by the Quipt identifier.

URLhttps://api.getquipt.com/v2/inventory/virtual/id/{id}
 
Methodget

Parameters:

Name Description Type Required
{id} The id value assigned to an virtual inventory item. String Yes
&include A comma separated list of properties to include with result. Valid options are Catalog, Details, Comments, Report, Freight, Properties. String No

Response Definitions:

Name Description Type
Result The virtual inventory result. InventoryVirtualResult

Acknowledge

This service allows a partner to create and update inventory items.

URLhttps://api.getquipt.com/v2/inventory/virtual/acknowledge
 
Methodpost

Body Definitions:

Name Description Type
Items The inventory items to create or update. InventoryVirtual[]
TransactionId The transaction id for the request. String

Response Definitions:

Name Description Type
ReportId The id used to lookup report details using the report endpoint. Guid
RecordsReceived The number of records received. Int
TransactionId The transaction id for the request. String
TransactionTime The time the transaction took place. DateTime
Success Whether or not the transaction was successful Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]

Batch Report

This service allows a partner to retrieve the detailed report generated when the ‘Acknowledge’ service is used. The result of ‘Acknowledge’ returns the {id} used to retrieve the report from this service.

URLhttps://api.getquipt.com/v2/inventory/virtual/report/{id}/{pageSize}/{pageNumber}
 
Methodget

Parameters:

Name Description Type Required
{pageSize} The maximum number of records to return. The maximum value is 200. Int Yes
{pageNumber} The page to retrieve. String No
{id} The report identifier. Guid Yes
&includeLines Flag whether or not to include the line details. Boolean No

Response Definitions:

Name Description Type
Result The collection of inventory reports. InventoryVirtual Report[]
ReportId The report id. Guid
ReportTime The time the report was generated. DateTime
ReportStatus The current status of the report. Int
Paging Paging information for the records returned. Paging
TransactionId The transaction id for the request. String
TransactionTime The time the transaction took place. DateTime
Success Whether or not the transaction was successful. Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]