inventory/item/get
POST/inventory/item/getThis returns the list of items available in the Equotix One account.
Request
The domain you are assigned to authenticate your Equotix One account.
The email address assigned to the user account in your Equotix One.
The unix timestamp used to sign this API request.
The calculated signature for this API request.
The item ID to search for specifically.
The model to search for specifically.
The SKU to search for specifically.
The barcode to search for specifically.
Filter the list of items by name.
Filter the list of items by brand ID.
Filter the list of items by Category IDs, comma separated.
Filter the list of items that have bundled items.
Filter the list of items modified after the spcified date.
Filter the list of items to include deleted records.
The channel group ID to search for, comma separated for multiple channel group IDs.
Page number of the results.
The key for the ordering of the results. Accepts "name", "model", "sku", "barcode", "quantity", "price", "cost", "average_cost", "pool_cost", "date_added", "date_modified"
The direction for the ordering of the results. Accepts "ASC", "DESC"
The number of results per page. Accepts 1 to 100.
{
"domain": "string",
"api_key": "string",
"auth_timestamp": 0,
"auth_signature": "string",
"item_id": 0,
"model": "string",
"sku": "string",
"barcode": "string",
"filter_name": "string",
"filter_brand_id": 0,
"filter_category": "string",
"filter_bundle": true,
"filter_date_modified": "string",
"filter_deleted": true,
"filter_channel_group_id": 0,
"page": 0,
"sort": "string",
"order": "string",
"limit": 0
}Responses
Returns only if there is an error.
The total number of results.
The item ID deleted if there is no error.
The item ID.
The parent item ID.
The channel group ID.
The brand ID.
The item name.
The description of the item.
The plain text description of the item.
The item image URL or image path in Equotix One.
The item images.
The item model code.
The item SKU code.
The item GTIN.
The item barcode.
The item total quantity.
The item price.
The item cost. Returned only if API has view cost permission.
The item weight in KG.
The item length in cm.
The item width in cm.
The item height in cm.
The total added quantity.
The total deducted quantity.
The average cost of the item. Returned only if API has view cost permission.
The total pool cost of the item. Returned only if API has view cost permission.
The date and time item was added.
The date and time item was last modified.
The locations data for the item.
The customer group data for the item.
The categories for the item.
The available translations for the item.
Indicate if this is a bundle item.
The items bundled in the item.
Indicates if the item has been deleted. Only returned if filter_deleted is "1".
{
"error": [
"string"
],
"total": 0,
"items": [
{
"item_id": 0,
"parent_id": 0,
"channel_group_id": 0,
"brand_id": 0,
"name": "string",
"description": "string",
"plain_description": "string",
"image": "string",
"images": [
{
"image": "string",
"set_id": 0,
"sort_order": 0
}
],
"model": "string",
"sku": "string",
"gtin": "string",
"barcode": "string",
"quantity": 0,
"price": 0,
"cost": 0,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"total_added": 0,
"total_deducted": 0,
"average_cost": 0,
"pool_cost": 0,
"date_added": "string",
"date_modified": "string",
"locations": [
{
"location_id": 0,
"quantity": 0,
"price": 0,
"name": "string",
"stock_warning": 0,
"stock_danger": 0,
"location": "string"
}
],
"customer_groups": [
{
"customer_group_id": 0,
"name": "string",
"price": 0
}
],
"categories": [
{
"category_id": 0,
"name": "string"
}
],
"translations": [
{
"language_id": 0,
"name": "string",
"description": "string",
"plain_description": "string"
}
],
"bundle": true,
"item_bundles": [
{
"bundle_item_id": 0,
"name": "string",
"quantity": 0
}
],
"deleted": true
}
]
}