Equotix One API
  1. Item
Equotix One API
  • Getting Started
    • Introduction
    • Authentication
    • API Example
    • Rate Limits
    • API Terms of Use
  • Extension
    • Dashboard
      • Announcement
        • extension/dashboard/announcement/get
    • Module
      • Invoice Copy
        • extension/module/invoice/get
    • Report
      • Channel Payout
        • extension/report/channel_payout/get
    • Total
      • Promotion
        • extension/total/promotion/get
        • extension/total/promotion/getCategory
        • extension/total/promotion/getHistory
      • Tax
        • extension/module/tax/get
  • Integration
    • Channel
      • integration/channel/get
    • Extension
      • integration/extension/get
    • Profile
      • integration/profile/get
  • Inventory
    • Addition
      • inventory/addition/add
      • inventory/addition/edit
      • inventory/addition/delete
      • inventory/addition/get
    • Brand
      • inventory/brand/add
      • inventory/brand/edit
      • inventory/brand/delete
      • inventory/brand/get
    • Category
      • inventory/category/add
      • inventory/category/edit
      • inventory/category/delete
      • inventory/category/get
    • Deduction
      • inventory/deduction/add
      • inventory/deduction/edit
      • inventory/deduction/delete
      • inventory/deduction/get
    • Flow
      • inventory/flow/get
    • Item
      • inventory/item/add
        POST
      • inventory/item/edit
        POST
      • inventory/item/delete
        POST
      • inventory/item/get
        POST
      • inventory/item/editStock
        POST
    • Location
      • inventory/location/add
      • inventory/location/edit
      • inventory/location/delete
      • inventory/location/get
    • Purchase Order
      • inventory/purchase_order/add
      • inventory/purchase_order/edit
      • inventory/purchase_order/delete
      • inventory/purchase_order/get
    • Reservation
      • inventory/reservation/add
      • inventory/reservation/edit
      • inventory/reservation/delete
      • inventory/reservation/get
    • Stock Take Job
      • inventory/stock_take_job/get
    • Supplier
      • inventory/supplier/add
      • inventory/supplier/edit
      • inventory/supplier/delete
      • inventory/supplier/get
    • Transfer Job
      • inventory/transfer_job/get
    • Transfer
      • inventory/transfer/add
      • inventory/transfer/edit
      • inventory/transfer/delete
      • inventory/transfer/get
  • Sale
    • Credit Note
      • sale/credit_note/add
      • sale/credit_note/edit
      • sale/credit_note/delete
      • sale/credit_note/get
      • sale/credit_note/getHistory
      • sale/credit_note/addHistory
    • Customer Group
      • sale/customer_group/add
      • sale/customer_group/edit
      • sale/customer_group/delete
      • sale/customer_group/get
    • Customer
      • sale/customer/add
      • sale/customer/edit
      • sale/customer/delete
      • sale/customer/get
      • sale/customer/addReward
      • sale/customer/getReward
    • Order
      • sale/order/add
      • sale/order/edit
      • sale/order/delete
      • sale/order/get
      • sale/order/getHistory
      • sale/order/addHistory
  • Setting
    • Channel Group
      • setting/channel_group/add
      • setting/channel_group/edit
      • setting/channel_group/delete
      • setting/channel_group/get
    • Company
      • setting/company/get
    • Credit Note Status
      • setting/credit_note_status/add
      • setting/credit_note_status/edit
      • setting/credit_note_status/delete
      • setting/credit_note_status/get
    • Currency
      • setting/currency/get
    • Language
      • setting/language/get
    • Order Status
      • setting/order_status/add
      • setting/order_status/edit
      • setting/order_status/delete
      • setting/order_status/get
    • Payment Method
      • setting/payment_method/add
      • setting/payment_method/edit
      • setting/payment_method/delete
      • setting/payment_method/get
    • User Group
      • setting/user_group/get
    • User
      • setting/user/get
  1. Item

inventory/item/get

POST
/inventory/item/get
This returns the list of items available in the Equotix One account.

Request

Body Params application/json
domain
string 
required
The domain you are assigned to authenticate your Equotix One account.
api_key
string 
required
The email address assigned to the user account in your Equotix One.
auth_timestamp
integer 
required
The unix timestamp used to sign this API request.
auth_signature
string 
required
The calculated signature for this API request.
item_id
integer 
optional
The item ID to search for specifically.
model
string 
optional
The model to search for specifically.
sku
string 
optional
The SKU to search for specifically.
barcode
string 
optional
The barcode to search for specifically.
filter_name
string 
optional
Filter the list of items by name.
filter_brand_id
integer 
optional
Filter the list of items by brand ID.
filter_category
string 
optional
Filter the list of items by Category IDs, comma separated.
filter_bundle
boolean 
optional
Filter the list of items that have bundled items.
filter_date_modified
string 
optional
Filter the list of items modified after the spcified date.
filter_deleted
boolean 
optional
Filter the list of items to include deleted records.
filter_channel_group_id
integer 
optional
The channel group ID to search for, comma separated for multiple channel group IDs.
page
integer 
optional
Page number of the results.
sort
string 
optional
The key for the ordering of the results. Accepts "name", "model", "sku", "barcode", "quantity", "price", "cost", "average_cost", "pool_cost", "date_added", "date_modified"
order
string 
optional
The direction for the ordering of the results. Accepts "ASC", "DESC"
limit
integer 
optional
The number of results per page. Accepts 1 to 100.
Example
{
  "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

🟢200Success
application/json
Body
error
array[string]
optional
Returns only if there is an error.
total
integer 
optional
The total number of results.
items
array [object {33}] 
optional
The item ID deleted if there is no error.
item_id
integer 
required
The item ID.
parent_id
integer 
required
The parent item ID.
channel_group_id
integer 
required
The channel group ID.
brand_id
integer 
required
The brand ID.
name
string 
required
The item name.
description
string 
required
The description of the item.
plain_description
string 
required
The plain text description of the item.
image
string 
required
The item image URL or image path in Equotix One.
images
array [object {3}] 
required
The item images.
model
string 
required
The item model code.
sku
string 
required
The item SKU code.
gtin
string 
required
The item GTIN.
barcode
string 
required
The item barcode.
quantity
integer 
required
The item total quantity.
price
number 
required
The item price.
cost
number 
optional
The item cost. Returned only if API has view cost permission.
weight
number 
required
The item weight in KG.
length
number 
required
The item length in cm.
width
number 
required
The item width in cm.
height
number 
required
The item height in cm.
total_added
integer 
required
The total added quantity.
total_deducted
integer 
required
The total deducted quantity.
average_cost
number 
optional
The average cost of the item. Returned only if API has view cost permission.
pool_cost
number 
optional
The total pool cost of the item. Returned only if API has view cost permission.
date_added
string 
required
The date and time item was added.
date_modified
string 
required
The date and time item was last modified.
locations
array [object {7}] 
required
The locations data for the item.
customer_groups
array [object {3}] 
required
The customer group data for the item.
categories
array [object {2}] 
required
The categories for the item.
translations
array [object {4}] 
required
The available translations for the item.
bundle
boolean 
required
Indicate if this is a bundle item.
item_bundles
array [object {3}] 
required
The items bundled in the item.
deleted
boolean 
optional
Indicates if the item has been deleted. Only returned if filter_deleted is "1".
Example
{
  "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
    }
  ]
}
Previous
inventory/item/delete
Next
inventory/item/editStock
Built with