Get Inventory List API

Endpoint

GET /inventory/overview

Headers

Key	Value
Authorization	Bearer change_to_your_access_token
X-S2-Organization	95d73baf-76ba-4bea-86ac-1534c5e5d4aa

Response Body

Field	Type	Description
warehouses	array	List of inventory warehouses. See Warehouse Object for details.
products	array	List of products. See Product Object for details.
items	array	List of inventory items. Check this items for detail inventory of products. See Item Object for item fields details.

Warehouse Object

Field	Type	Description
id	string	Unique identifier for the warehouse
organization	Organization Object	Information about the warehouse's organization. See Organization Object for details.
name	string	Name of the warehouse
address	Address Object	Physical address of the warehouse. See Address Object for details.
dropshipper	boolean	Whether the warehouse is a dropshipper
fulfillmentCenter	boolean	Whether the warehouse is a fulfillment center
rmaCenter	boolean	Whether the warehouse is an RMA center
unitSystem	string	Unit system used (e.g., "METRIC")
createdAt	string	Timestamp when the warehouse was created (ISO 8601 format)
updatedAt	string	Timestamp when the warehouse was last updated (ISO 8601 format)

Organization Object

Field	Type	Description
id	string	Unique identifier for the organization
name	string	Name of the organization
createdAt	string	Timestamp when the organization was created (ISO 8601 format)
updatedAt	string	Timestamp when the organization was last updated (ISO 8601 format)

Address Object

Field	Type	Description
name	string	The name associated with the address
company	string	Company name
address1	string	Primary street address
address2	string	Additional address information
city	string	City name
state	string	State or province
postalCode	string	Postal or ZIP code
countryId	string	Country code in ISO 3166-1 alpha-2 format (e.g., "CA")
phone	string	Contact phone number
email	string	Contact email address

Product Object

Field	Type	Description
id	string	Unique identifier for the product
organization	Organization Object	Organization that owns the product
sku	string	Stock keeping unit
brand	Brand Object	Brand information. See Brand Object for details
gtin	string	Global Trade Item Number
name	string	Product name
remarks	string	Additional remarks about the product
imageMain	string	URL of the main product image
packageLengthMm	number	Package length in millimeters
packageWidthMm	number	Package width in millimeters
packageHeightMm	number	Package height in millimeters
shippingWeightKg	number	Shipping weight in kilograms
caseUnit	string	Unit of measurement for cases (e.g., "EACH", "CARTON")
casePack	integer	Number of items per case
caseLengthMm	number	Case length in millimeters
caseWidthMm	number	Case width in millimeters
caseHeightMm	number	Case height in millimeters
caseWeightKg	number	Case weight in kilograms
condition	string	Product condition (e.g., "NEW")
serialNumberRequired	boolean	Whether serial number is required
expiryDateRequired	boolean	Whether expiry date is required
unknown	boolean	Whether the product is unknown
createdAt	string	Timestamp when the product was created (ISO 8601 format)
updatedAt	string	Timestamp when the product was last updated (ISO 8601 format)
otherIds	array	List of other identifiers associated with the product

Brand Object

Field	Type	Description
id	string	Unique identifier for the brand
name	string	Brand name
nameNormalized	string	Normalized version of the brand name
createdAt	string	Timestamp when the brand was created (ISO 8601 format)

Item Object

Field	Type	Description
warehouseId	string	Identifier of the warehouse where the inventory is located
level	object	Inventory level information. See Level Object for details

Level Object

Field	Type	Description
productId	string	Identifier of the product
available	integer	Inventory of units available of the product
incoming	integer	Inventory of units expected to arrive
reserved	integer	Inventory of units reserved for orders
updatedAt	string	Timestamp when the level was last updated (ISO 8601 format)

Response Example

json

{
  "warehouses": [
    {
      "id": "9cae310d-c440-4d78-bdc0-bf306ec33888",
      "organization": {
        "id": "e8b021f4-9ab3-4fc2-af71-f35930759888",
        "name": "test organization",
        "createdAt": "2024-04-01T14:09:14.732646Z",
        "updatedAt": "2024-04-09T21:15:15.615765Z"
      },
      "name": "test warehouse",
      "address": {
        "name": "GDI",
        "company": "",
        "address1": "test warehouse Rd Unit 3",
        "address2": "",
        "city": "Oakville",
        "state": "ON",
        "postalCode": "L6L 2X8",
        "countryId": "CA",
        "phone": "",
        "email": ""
      },
      "dropshipper": true,
      "fulfillmentCenter": true,
      "rmaCenter": true,
      "unitSystem": "METRIC",
      "createdAt": "2024-04-01T14:18:10.903581Z",
      "updatedAt": "2024-04-01T14:18:10.903581Z"
    },
    {
      "id": "0b6eaafa-565f-4989-b3d5-98e871f9e888",
      "organization": {
        "id": "e4affb47-1971-42bb-97a3-215d9bddd888",
        "name": "Sellersoft",
        "createdAt": "2024-03-05T22:16:05.692314Z",
        "updatedAt": "2024-04-09T21:15:15.615765Z"
      },
      "name": "test Warehouse2",
      "address": {
        "name": "Test",
        "company": "Ventmere",
        "address1": "145 test road",
        "address2": "",
        "city": "Markham",
        "state": "ON",
        "postalCode": "L3R 8A9",
        "countryId": "CA",
        "phone": "",
        "email": ""
      },
      "dropshipper": true,
      "fulfillmentCenter": true,
      "rmaCenter": true,
      "unitSystem": "METRIC",
      "createdAt": "2024-03-05T22:16:48.618677Z",
      "updatedAt": "2024-03-05T22:16:48.618677Z"
    }
  ],
  "products": [
    {
      "id": "3775cc37-30e7-4579-a58e-c9adda6fa888",
      "organization": {
        "id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
        "name": "test organization",
        "createdAt": "2024-03-05T22:17:23.520948Z",
        "updatedAt": "2024-04-09T21:15:15.615765Z"
      },
      "sku": "test",
      "brand": {
        "id": "e0cbbf33-cbea-4867-9fd9-5d72f22c2321",
        "name": "Sony",
        "nameNormalized": "sony",
        "createdAt": "2024-06-04T03:16:22.617577Z"
      },
      "gtin": "7045557638888",
      "name": "Test Product",
      "remarks": "test.",
      "imageMain": "95d73baf-76ba-4bea-86ac-1534c5e5d4aa/2024-04-23/avatar/听雨__24_x_26.25__PFPWig_4_YXKT59pJLuoIk82VgaF.jpg",
      "packageLengthMm": 33.27078,
      "packageWidthMm": 64.29312,
      "packageHeightMm": 96.57682,
      "shippingWeightKg": 76.44365,
      "caseUnit": "EACH",
      "casePack": 2,
      "caseLengthMm": 34.340958,
      "caseWidthMm": 20.323586,
      "caseHeightMm": 12.659683,
      "caseWeightKg": 0.35708416,
      "condition": "NEW",
      "serialNumberRequired": true,
      "expiryDateRequired": true,
      "unknown": false,
      "createdAt": "2024-06-04T03:16:22.617577Z",
      "updatedAt": "2024-06-04T03:31:28.192345Z",
      "otherIds": []
    },
    {
      "id": "440352eb-241a-4cac-834f-e0980ffca888",
      "organization": {
        "id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
        "name": "test organization",
        "createdAt": "2024-03-05T22:17:23.520948Z",
        "updatedAt": "2024-04-09T21:15:15.615765Z"
      },
      "sku": "MX03-N-BLUE",
      "brand": {
        "id": "5643b7ee-7df1-48c6-b690-1e29ffa8a888",
        "name": "",
        "nameNormalized": "",
        "createdAt": "2024-03-05T22:17:28.679732Z"
      },
      "gtin": "",
      "name": "SKU Blue",
      "remarks": "",
      "imageMain": "",
      "packageLengthMm": 1500.0,
      "packageWidthMm": 260.0,
      "packageHeightMm": 810.0,
      "shippingWeightKg": 34.0,
      "caseUnit": "CARTON",
      "casePack": 1,
      "caseLengthMm": 0.0,
      "caseWidthMm": 0.0,
      "caseHeightMm": 0.0,
      "caseWeightKg": 0.0,
      "condition": "NEW",
      "serialNumberRequired": false,
      "expiryDateRequired": false,
      "unknown": false,
      "createdAt": "2024-03-05T22:20:44.106742Z",
      "updatedAt": "2024-04-01T14:31:19.875675Z",
      "otherIds": []
    },
    {
      "id": "bab7c35b-2ecb-4b40-be82-8dc1e0a86888",
      "organization": {
        "id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
        "name": "test organization",
        "createdAt": "2024-03-05T22:17:23.520948Z",
        "updatedAt": "2024-04-09T21:15:15.615765Z"
      },
      "sku": "SKU-GREY",
      "brand": {
        "id": "5643b7ee-7df1-48c6-b690-1e29ffa8a888",
        "name": "",
        "nameNormalized": "",
        "createdAt": "2024-03-05T22:17:28.679732Z"
      },
      "gtin": "",
      "name": "SKU GREY",
      "remarks": "",
      "imageMain": "",
      "packageLengthMm": 1500.0,
      "packageWidthMm": 260.0,
      "packageHeightMm": 810.0,
      "shippingWeightKg": 35.0,
      "caseUnit": "CARTON",
      "casePack": 1,
      "caseLengthMm": 0.0,
      "caseWidthMm": 0.0,
      "caseHeightMm": 0.0,
      "caseWeightKg": 0.0,
      "condition": "NEW",
      "serialNumberRequired": false,
      "expiryDateRequired": false,
      "unknown": false,
      "createdAt": "2024-03-05T22:20:44.132006Z",
      "updatedAt": "2024-04-01T14:31:19.885955Z",
      "otherIds": []
    },
    {
      "id": "f4053402-e79b-45c2-8621-377d28060888",
      "organization": {
        "id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
        "name": "test organization",
        "createdAt": "2024-03-05T22:17:23.520948Z",
        "updatedAt": "2024-04-09T21:15:15.615765Z"
      },
      "sku": "TEST-BLACK",
      "brand": {
        "id": "5643b7ee-7df1-48c6-b690-1e29ffa8a888",
        "name": "",
        "nameNormalized": "",
        "createdAt": "2024-03-05T22:17:28.679732Z"
      },
      "gtin": "871160888",
      "name": "SKU Black",
      "remarks": "",
      "imageMain": "",
      "packageLengthMm": 1470.0,
      "packageWidthMm": 310.0,
      "packageHeightMm": 790.0,
      "shippingWeightKg": 34.0,
      "caseUnit": "EACH",
      "casePack": 0,
      "caseLengthMm": 0.0,
      "caseWidthMm": 0.0,
      "caseHeightMm": 0.0,
      "caseWeightKg": 0.0,
      "condition": "NEW",
      "serialNumberRequired": false,
      "expiryDateRequired": false,
      "unknown": false,
      "createdAt": "2024-03-05T22:20:44.087204Z",
      "updatedAt": "2024-03-05T22:20:44.087204Z",
      "otherIds": []
    },
    {
      "id": "4d5ab278-86f3-4237-993b-b16a19360888",
      "organization": {
        "id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
        "name": "test organization",
        "createdAt": "2024-03-05T22:17:23.520948Z",
        "updatedAt": "2024-04-09T21:15:15.615765Z"
      },
      "sku": "S600-LIGHT-GRAY",
      "brand": {
        "id": "5643b7ee-7df1-48c6-b690-1e29ffa8a888",
        "name": "",
        "nameNormalized": "",
        "createdAt": "2024-03-05T22:17:28.679732Z"
      },
      "gtin": "",
      "name": "SKU GRAY",
      "remarks": "",
      "imageMain": "",
      "packageLengthMm": 1520.0,
      "packageWidthMm": 310.0,
      "packageHeightMm": 820.0,
      "shippingWeightKg": 44.0,
      "caseUnit": "CARTON",
      "casePack": 1,
      "caseLengthMm": 0.0,
      "caseWidthMm": 0.0,
      "caseHeightMm": 0.0,
      "caseWeightKg": 0.0,
      "condition": "NEW",
      "serialNumberRequired": false,
      "expiryDateRequired": false,
      "unknown": false,
      "createdAt": "2024-04-01T14:31:19.830702Z",
      "updatedAt": "2024-04-01T14:31:19.830702Z",
      "otherIds": []
    }
  ],
  "items": [
    {
      "warehouseId": "9cae310d-c440-4d78-bdc0-bf306ec33888",
      "level": {
        "productId": "f4053402-e79b-45c2-8621-377d28060888",
        "available": 0,
        "incoming": 0,
        "reserved": -13,
        "updatedAt": "2024-06-03T03:40:41.743844Z"
      }
    },
    {
      "warehouseId": "9cae310d-c440-4d78-bdc0-bf306ec33888",
      "level": {
        "productId": "440352eb-241a-4cac-834f-e0980ffc888",
        "available": 11,
        "incoming": 0,
        "reserved": -7,
        "updatedAt": "2024-06-03T03:40:41.743844Z"
      }
    },
    {
      "warehouseId": "9cae310d-c440-4d78-bdc0-bf306ec33888",
      "level": {
        "productId": "bab7c35b-2ecb-4b40-be82-8dc1e0a86171",
        "available": 17,
        "incoming": 0,
        "reserved": -7,
        "updatedAt": "2024-06-04T05:53:31.054574Z"
      }
    },
    {
      "warehouseId": "9cae310d-c440-4d78-bdc0-bf306ec33888",
      "level": {
        "productId": "4d5ab278-86f3-4237-993b-b16a19360b41",
        "available": 9,
        "incoming": 0,
        "reserved": 0,
        "updatedAt": "2024-04-01T15:06:00.817191Z"
      }
    },
    {
      "warehouseId": "9cae310d-c440-4d78-bdc0-bf306ec33888",
      "level": {
        "productId": "3775cc37-30e7-4579-a58e-c9adda6fa888",
        "available": 0,
        "incoming": 0,
        "reserved": -2,
        "updatedAt": "2024-06-04T05:53:31.054574Z"
      }
    }
  ]
}

Get Inventory List API ​

Endpoint ​

Headers ​

Response Body ​

Warehouse Object ​

Organization Object ​

Address Object ​

Product Object ​

Brand Object ​

Item Object ​

Level Object ​

Response Example ​

Get Inventory List API

Endpoint

Headers

Response Body

Warehouse Object

Organization Object

Address Object

Product Object

Brand Object

Item Object

Level Object

Response Example