Articles in this section

See more

Inventory / Item

Items

The available APIs for items are explained below.

inventory/item/add

This adds an item to the Equotix One account.

 

Path

/api/inventory/item/add

 

POST Parameters

Name Type Required Description
domain string Yes The domain you are assigned to authenticate your Equotix One account.
api_key string Yes The email address assigned to the user account in your Equotix One.
auth_timestamp int Yes The unix timestamp used to sign this API request.
auth_signature string Yes

The calculated signature for this API request.
name string Yes The name of the item.
model string Yes

The item model code.
description string Yes

The description of the item. HTML supported.
plain_description string Yes

The plain text description of the item.
sku string Yes

The item SKU code.
barcode string Yes

The item barcode.
weight float Yes

The weight of the item in KG.
length float Yes

The length of the item in cm.
width float Yes

The width of the item in cm.
height float Yes

The height of the item in cm.
parent_id int Yes

The parent item ID. Use 0 if is a parent itself.
brand_id int Yes

The brand ID for the item.
image string Yes

The image URL or file path to the image stored on Equotix One. Leave empty if none.
price float Yes

The price of the item.
cost float Yes

The cost of the item.
retail float Yes

The retail price of the item.
total_added int Yes

The total added quantity for the item.
total_deducted int Yes

The total deducted quantity for the item.
average_cost float Yes

The average cost of the item.
pool_cost float Yes

The total cost of the item pool.
images object No

The images for the item.
> image string Yes

The image URL or file path to the image stored on Equotix One.
> sort_order int Yes

The sort order for the images.
customer_groups object No

The customer group pricing for the item.
> customer_group_id int Yes

The customer group ID.
> price float Yes

The price of the item for this customer group.
locations object No

The location quantity and price for the item.
> location_id int Yes

The location ID.
> quantity int Yes

The quantity for the location. This value will not be used if inventory integrity is enabled.
> price float Yes

The price of the item for the location.
> stock_warning int Yes

The warning quantity level for this item at the location.
> stock_danger int Yes

The danger quantity level for this item at the location.
> location string Yes

The rack location the item is stored at the warehouse location.
categories object No

The category IDs to be used for the item.
translations object No

The translations for the item.
> language_id int Yes

The language ID.
> name string Yes

The translated item name.
> description string Yes

The translated item description. HTML supported.
> plain_description string Yes

The translated plain text description of the item.
bundle int No

"1" to enable bundle, "0" to disabled.
item_bundles object No

Required if bundle is enabled.
> bundle_item_id int Yes

The item to bundle.
> quantity int Yes

The quantity of the item bundled.


Response Parameters

Name Type Description
success boolean True if added.
item_id int The newly added item ID.
error object The errors relating to the API call.

 

inventory/item/edit

This edits an item in the Equotix One account.

 

Path

/api/inventory/item/edit

 

POST Parameters

Name Type Required Description
domain string Yes The domain you are assigned to authenticate your Equotix One account.
api_key string Yes The email address assigned to the user account in your Equotix One.
auth_timestamp int Yes The unix timestamp used to sign this API request.
auth_signature string Yes

The calculated signature for this API request.
item_id int Yes

The item ID to edit.
name string Yes The name of the item.
model string Yes

The item model code.
description string Yes

The description of the item. HTML supported.
plain_description string Yes

The plain text description of the item.
sku string Yes

The item SKU code.
barcode string Yes

The item barcode.
weight float Yes

The weight of the item in KG.
length float Yes

The length of the item in cm.
width float Yes

The width of the item in cm.
height float Yes

The height of the item in cm.
parent_id int Yes

The parent item ID. Use 0 if is a parent itself.
brand_id int Yes

The brand ID for the item.
image string Yes

The image URL or file path to the image stored on Equotix One. Leave empty if none.
price float Yes

The price of the item.
cost float Yes

The cost of the item.
retail float Yes

The retail price of the item.
total_added int Yes

The total added quantity for the item.
total_deducted int Yes

The total deducted quantity for the item.
average_cost float Yes

The average cost of the item.
pool_cost float Yes

The total cost of the item pool.
images object No

The images for the item.
> image string Yes

The image URL or file path to the image stored on Equotix One.
> sort_order int Yes

The sort order for the images.
customer_groups object No

The customer group pricing for the item.
> customer_group_id int Yes

The customer group ID.
> price float Yes

The price of the item for this customer group.
locations object No

The location quantity and price for the item.
> location_id int Yes

The location ID.
> quantity int Yes

The quantity for the location. This value will not be used if inventory integrity is enabled.
> price float Yes

The price of the item for the location.
> stock_warning int Yes

The warning quantity level for this item at the location.
> stock_danger int Yes

The danger quantity level for this item at the location.
> location string Yes

The rack location the item is stored at the warehouse location.
categories object No

The category IDs to be used for the item.
translations object No

The translations for the item.
> language_id int Yes

The language ID.
> name string Yes

The translated item name.
> description string Yes

The translated item description. HTML supported.
> plain_description string Yes

The translated plain text description of the item.
bundle int No

"1" to enable bundle, "0" to disabled.
item_bundles object No

Required if bundle is enabled.
> bundle_item_id int Yes

The item to bundle.
> quantity int Yes

The quantity of the item bundled.

 

Response Parameters

Name Type Description
success boolean True if edited.
item_id int The edited item ID.
error object The errors relating to the API call.

 

inventory/item/delete

This deletes an item from the Equotix One account.

 

Path

/api/inventory/item/delete

 

POST Parameters

Name Type Required Description
domain string Yes The domain you are assigned to authenticate your Equotix One account.
api_key string Yes The email address assigned to the user account in your Equotix One.
auth_timestamp int Yes The unix timestamp used to sign this API request.
auth_signature string Yes

The calculated signature for this API request.
item_id int No

The item ID. Choose either of the parameters to find an item to delete.
model string No

The model of the item.
sku string No

The SKU of the item.
barcode string No

The barcode of the item.


Response Parameters

Name Type Description
success boolean True if deleted.
error object The errors relating to the API call.

 

inventory/item/get

This gets a list of items or a specific item from the Equotix One account.

 

Path

/api/inventory/item/get

 

POST Parameters

Name Type Required Description
domain string Yes The domain you are assigned to authenticate your Equotix One account.
api_key string Yes The email address assigned to the user account in your Equotix One.
auth_timestamp int Yes The unix timestamp used to sign this API request.
auth_signature string Yes

The calculated signature for this API request.
item_id int No

The item ID to search for specifically.
model string No

The model to search for specifically.
sku string No

The SKU to search for specifically.
barcode string No

The barcode to search for specifically.
filter_name string No

Filter the results by item name.
filter_date_modified string No

Filter the results by items modified after this date.
page int No

Page number of the results.


Response Parameters

Name Type Description
items object The items results.
> item_id int The item ID.
> parent_id int The parent item ID.
> brand_id int The brand ID.
> name string The item name.
> description string The description of the item.
> plain_description string The plain text description of the item.
> image string The item image URL.
> images object The item images.
> model string The item model code.
> sku string The item SKU code.
> barcode string The item barcode.
> quantity int The item total quantity.
> price float The item price.
> cost float The item cost.
> retail float The item retail price.
> weight float The item weight in KG.
> length float The item length in cm.
> width float The item width in cm.
> height float The item height in cm.
> total_added int The total added quantity.
> total_deducted int The total deducted quantity.
> average_cost float The average cost of the item.
> pool_cost float The total pool cost of the item.
> date_added string The date and time item was added.
> date_modified string The date and time item was last modified.
> locations object The locations for the item.
>> location_id int The location ID.
>> quantity int The quantity at the location.
>> price float The price at the location.
>> name string The location name.
>> stock_warning int The stock warning level.
>> stock_danger int The stock danger level.
> customer_groups object The customer group data for the item.
>> customer_group_id int The customer group ID.
>> name string The customer group name.
>> price float The item price for this customer group.
> categories object The categories for the item.
>> category_id int The category ID.
>> name string The category name.
> translations object The available translations for the item.
>> language_id int The language ID.
>> name string The translated name of the item.
>> description string The translated description of the item.
>> plain_description string The translated plain text description of the item.
> bundle int Indicate if this is a bundle item.
> item_bundles object The items bundled in the item.
>> bundle_item_id int The bundled item ID.
>> name string The name of the bundled item.
>> quantity int The quantity bundled for the bundle item.
total int The total number of results.

 

inventory/item/editStock

This edits up to 100 items stock on the Equotix One account.

 

Path

/api/inventory/item/editStock

 

POST Parameters

Name Type Required Description
domain string Yes The domain you are assigned to authenticate your Equotix One account.
api_key string Yes The email address assigned to the user account in your Equotix One.
auth_timestamp int Yes The unix timestamp used to sign this API request.
auth_signature string Yes

The calculated signature for this API request.
items object Yes

The items to edit.
> model string No

The model of the item.
> sku string No

The SKU of the item.
> barcode string No

The barcode of the item.
> location_id int Yes

The location stock to update.
> quantity int Yes

The new quantity at the location.
> cost float Yes

The cost for the item.
currency string No

The currency code for the cost used.
currency_value float No

The currency value, only if currency is set.


Response Parameters

Name Type Description
success boolean True if deleted.
error object The errors relating to the API call.

 

Related articles

Comments

0 comments

Article is closed for comments.