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/edit

POST
/inventory/item/edit
This edits an item 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 
required
The item ID to edit.
name
string 
required
The name of the item.
model
string 
required
The item model code.
description
string 
required
The description of the item. HTML supported.
plain_description
string 
required
The plain text description of the item.
channel_group_id
integer 
required
The channel group ID for restriction control. Accepts 0 if none.
sku
string 
required
The item SKU code.
gtin
string 
required
The item GTIN code.
barcode
string 
required
The item barcode.
weight
number 
required
The weight of the item in KG.
length
number 
required
The length of the item in cm.
width
number 
required
The width of the item in cm.
height
number 
required
The height of the item in cm.
parent_id
integer 
required
The parent item ID. Use 0 if it is a parent itself.
brand_id
integer 
required
The brand ID for the item. Accepts 0.
image
string 
required
The image URL or file path to the image stored on Equotix One. Leave empty if none.
price
number 
required
The price of the item.
cost
number 
optional
The cost of the item. Only if API has view cost permission.
total_added
integer 
required
The total added quantity for the item as at now. Accepts 0.
total_deducted
integer 
required
The total deducted quantity for the item as at now. Accepts 0.
average_cost
number 
optional
The average cost of the item. Only if API has view cost permission.
pool_cost
number 
optional
The pool cost of the item. Only if API has view cost permission.
images
array [object {2}] 
required
The images for the item.
image
string 
required
The image URL or file path to the image stored on Equotix One.
set_id
integer 
required
The image set number. Accepts 0 to 9 only.
locations
array [object {6}] 
optional
The location quantity and price for the item.
location_id
integer 
required
The location ID.
quantity
integer 
required
The quantity available in this location. Quantity will not be set if inventory integrity is enabled.
price
number 
required
The price of the item for the location.
stock_warning
integer 
required
The warning quantity level for this item at the location.
stock_danger
integer 
required
The danger quantity level for this item at the location.
location
string 
required
The rack location the item is stored at.
customer_groups
array [object {2}] 
optional
The customer group pricing for the item.
customer_group_id
integer 
required
The customer group ID.
price
number 
required
The price of the item for this customer group.
categories
array[integer]
required
The category IDs to be used for the item.
bundle
integer 
required
Set whether this item is a bundle item. 1 to enable bundle, 0 to disable.
item_bundles
array [object {2}] 
optional
Required if bundle is enabled. Contains the actual items and quantities in the bundle.
bundle_item_id
integer 
required
The item to bundle.
quantity
integer 
required
The quantity of the item bundled.
translations
array [object {4}] 
optional
The translations for the item.
language_id
integer 
required
The language ID.
name
string 
required
The translated item name.
description
string 
required
The translated item description. HTML supported.
plain_description
string 
required
The translated plain text description of the item.
Example
{
  "domain": "string",
  "api_key": "string",
  "auth_timestamp": 0,
  "auth_signature": "string",
  "item_id": 0,
  "name": "string",
  "model": "string",
  "description": "string",
  "plain_description": "string",
  "channel_group_id": 0,
  "sku": "string",
  "gtin": "string",
  "barcode": "string",
  "weight": 0,
  "length": 0,
  "width": 0,
  "height": 0,
  "parent_id": 0,
  "brand_id": 0,
  "image": "string",
  "price": 0,
  "cost": 0,
  "total_added": 0,
  "total_deducted": 0,
  "average_cost": 0,
  "pool_cost": 0,
  "images": [
    {
      "image": "string",
      "set_id": 0
    }
  ],
  "locations": [
    {
      "location_id": 0,
      "quantity": 0,
      "price": 0,
      "stock_warning": 0,
      "stock_danger": 0,
      "location": "string"
    }
  ],
  "customer_groups": [
    {
      "customer_group_id": 0,
      "price": 0
    }
  ],
  "categories": [
    0
  ],
  "bundle": 0,
  "item_bundles": [
    {
      "bundle_item_id": 0,
      "quantity": 0
    }
  ],
  "translations": [
    {
      "language_id": 0,
      "name": "string",
      "description": "string",
      "plain_description": "string"
    }
  ]
}

Responses

🟢200Success
application/json
Body
error
array[string]
optional
Returns only if there is an error.
success
boolean 
optional
Returns only if there is no error.
item_id
integer 
optional
The edited item ID.
Example
{
  "error": [
    "string"
  ],
  "success": true,
  "item_id": 0
}
Previous
inventory/item/add
Next
inventory/item/delete
Built with