Inventory / Brand

Brands

The available APIs for brands are explained below.

inventory/brand/add

This adds a brand to the Equotix One account.

 

Path

/api/inventory/brand/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 brand.
image	string	Yes	The image URL or file path to the image stored on Equotix One. Leave empty if none.

Response Parameters

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

 

inventory/brand/edit

This edits a brand in the Equotix One account.

 

Path

/api/inventory/brand/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.
brand_id	int	Yes	The brand ID to edit.
name	string	Yes	The name of the brand.
image	string	Yes	The image URL or file path to the image stored on Equotix One. Leave empty if none.

Response Parameters

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

 

inventory/brand/delete

This deletes a brand from the Equotix One account.

 

Path

/api/inventory/brand/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.
brand_id	int	Yes	The brand ID.

Response Parameters

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

 

inventory/brand/get

This gets a list of brands or a specific brand from the Equotix One account.

 

Path

/api/inventory/brand/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.
brand_id	int	No	The brand ID to search for specifically.
filter_name	string	No	Filter the results by brand name.
filter_date_modified	string	No	Filter the results by brands modified after this date.
page	int	No	Page number of the results.

Response Parameters

Name	Type	Description
brands	object	The brands results.
> brand_id	int	The brand ID.
> name	string	The brand name.
> image	string	The brand image URL.
> date_modified	string	The date and time brand was last modified.
total	int	The total number of results.