Get All Inventory

Overview

In order to retrieve metadata for existing inventories, you must:

  • Be authenticated user

Information on how you can authenticate: Authentication

As soon as you do authentication and receive a valid token, it needs to be passed on the call for getting inventories

  • User can provide page number and page size, filtering or sorting information

Endpoint

Example for such endpoint for TT server: https://tt.api.sellercloud.com/rest/api/inventory?pageNumber=1&pageSize=1

Request

Information about expected request parameters and their type can be found on swagger UI https://tt/api.sellercloud.com/rest/swagger.

  • Method Type: HttpGet
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json
  • Parameters:

Parameters

Data Type

Description

Is Required

pageNumber

integer

Number of page

no

pageSize

integer

Number of inventories per page

no

inventoryID

List<string>

List of IDs of inventories

no

poID

List<integer>

List of IDs of purchase orders

no

vendorID

List<integer>

List of IDs of vendors

no

vendorSKU

List<integer>

List of SKUs of vendors

no

warehouse

List<integer>

List of IDs of warehouses

no

upc

integer

Universal Product Code number

no

physicalQtyFrom

integer

Minimum physical qty

no

physicalQtyTo

integer

Maximum physical qty

no

kitType

integer

Independant=0, MainComponent=1, AllComponents=2

no

LastUpdatedFrom

datetime

Datetime indicating from when was last modified. Optional.

no

LastUpdatedTo

datetime

Datetime indicating to when was last modified. Optional

no

LastAggregateFrom

datetime

From last aggregation date. Optional

no

LastAggregateTo

datetime

To last aggregation date. Optional

no

Response

  • If user is authenticated and provides a valid page number and page size, then response will be Status Code 200 => OK and inventories metadata in JSON format
{ 
"Items": [],
TotalResults: 0
}
  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • On server response => Status Code 500 => Internal Server Error

Attachments


How did we do?