Inventory


The inventory services below provide the ability to manage inventory listings within Quipt. The provided services can be used manage everything from quantity synchronization to creating, publishing, and listing the inventory on partner sites. Click here for a few use cases using the inventory services.

Get Inventory

This services allows a partner to retrieve a paged list of inventory items currently listed by the partner. The service returns all inventory records created within Quipt. This includes both complete and incomplete inventory items.

URLhttps://api.getquipt.com/v2/inventory/physical/{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
&skus A comma separated list of skus to retrieve, ie WIDGET1,WIDGET2. String No
&ids A comma separated list of Quipt ids. String No
&include A comma separated list of properties to include with result. Valid options are Feeds, Catalog, Comments, History, and Report. String No

Sample Header:

Sample Response (JSON):

Response Definitions:

Name Description Type
Paging Paging information for the records returned. Paging
Result The collection of inventory results. Inventory Result[]
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 Inventory By SKU

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

URLhttps://api.getquipt.com/v2/inventory/physical/1/1?skus={skus}
 
Methodget

Parameters:

Name Description Type Required
&skus The sku to retrieve, ie \"WIDGET1,WIDGET2\". String No
&include A comma separated list of properties to include with result. Valid options are Feeds, Catalog, Comments, History, and Report. String No

Sample Header:

Sample Response (JSON):
Sample Response (JSON):

Response Definitions:

Name Description Type
Result The inventory result. InventoryResult

Get 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/physical/id/{id}
 
Methodget

Parameters:

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

Sample Header:

Sample Response (JSON):

Response Definitions:

Name Description Type
Result The inventory result. InventoryResult

Create/Update Inventory

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

URLhttps://api.getquipt.com/v2/inventory/physical
 
Methodpost

Body Definitions:

Name Description Type
Purge Whether or not to purge the current inventory list and replace with the items included in this collection. Boolean
Items The inventory items to create or update. Inventory[]
TransactionId The transaction id for the request. String

Sample Header:

Sample Request (JSON):

Sample Response (JSON):

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 ‘Create/Update Inventory’ service is used. The result of ‘Create/Update Inventory’ returns the {id} used to retrieve the report from this service.

URLhttps://api.getquipt.com/v2/inventory/physical/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

Sample Header:

Sample Response (JSON):

Response Definitions:

Name Description Type
Result The collection of inventory reports. Inventory 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 inventory listings within Quipt. The provided services can be used manage everything from quantity synchronization to creating, publishing, and listing the inventory on partner sites. Click here for a few use cases using the inventory services.

Get Inventory

This services allows a partner to retrieve a paged list of inventory items currently listed by the partner. The service returns all inventory records created within Quipt. This includes both complete and incomplete inventory items.

URLhttps://api.getquipt.com/v2/inventory/physical/{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
&skus A comma separated list of skus to retrieve, ie WIDGET1,WIDGET2. String No
&ids A comma separated list of Quipt ids. String No
&include A comma separated list of properties to include with result. Valid options are Feeds, Catalog, Comments, History, and Report. String No

Sample Header:

Sample Response (JSON):

Response Definitions:

Name Description Type
Paging Paging information for the records returned. Paging
Result The collection of inventory results. Inventory Result[]
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 Inventory By SKU

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

URLhttps://api.getquipt.com/v2/inventory/physical/1/1?skus={skus}
 
Methodget

Parameters:

Name Description Type Required
&skus The sku to retrieve, ie \"WIDGET1,WIDGET2\". String No
&include A comma separated list of properties to include with result. Valid options are Feeds, Catalog, Comments, History, and Report. String No

Sample Header:

Sample Response (JSON):
Sample Response (JSON):

Response Definitions:

Name Description Type
Result The inventory result. InventoryResult

Get 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/physical/id/{id}
 
Methodget

Parameters:

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

Sample Header:

Sample Response (JSON):

Response Definitions:

Name Description Type
Result The inventory result. InventoryResult

Create/Update Inventory

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

URLhttps://api.getquipt.com/v2/inventory/physical
 
Methodpost

Body Definitions:

Name Description Type
Purge Whether or not to purge the current inventory list and replace with the items included in this collection. Boolean
Items The inventory items to create or update. Inventory[]
TransactionId The transaction id for the request. String

Sample Header:

Sample Request (JSON):

Sample Response (JSON):

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 ‘Create/Update Inventory’ service is used. The result of ‘Create/Update Inventory’ returns the {id} used to retrieve the report from this service.

URLhttps://api.getquipt.com/v2/inventory/physical/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

Sample Header:

Sample Response (JSON):

Response Definitions:

Name Description Type
Result The collection of inventory reports. Inventory 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[]