Articles in this section

See more

Sale / Customer

Customers

The available APIs for customers are explained below.

sale/customer/add

This adds a customer to the Equotix One account.

 

Path

/api/sale/customer/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.
firstname string Yes The first name of the customer.
lastname string Yes

The last name of the customer.
company string Yes

The customer company.
customer_group_id string Yes

The customer group ID.
email string Yes

The customer email.
telephone string Yes

The customer telephone.
card_number string Yes

The card number for membership. Can be empty.


Response Parameters

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

 

sale/customer/edit

This edits a customer in the Equotix One account.

 

Path

/api/sale/customer/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.
customer_id int Yes

The customer ID to edit.
firstname string Yes The first name of the customer.
lastname string Yes

The last name of the customer.
company string Yes

The customer company.
customer_group_id string Yes

The customer group ID.
email string Yes

The customer email.
telephone string Yes

The customer telephone.
card_number string Yes

The card number for membership. Can be empty.

 

Response Parameters

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

 

sale/customer/delete

This deletes a customer from the Equotix One account.

 

Path

/api/sale/customer/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.
customer_id int No

The customer ID.


Response Parameters

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

 

sale/customer/get

This gets a list of customers or a specific customer from the Equotix One account.

 

Path

/api/sale/customer/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.
customer_id int No

The customer ID to search for specifically.
search string No

Filter the results by customer name, telephone or email.
filter_name string No

Filter the results by the customer name.
filter_customer_group_id string No

Filter the results by the customer group ID.
filter_email string No

Filter the results by the email.
filter_telephone string No

Filter the results by the telephone.
filter_card_number string No

Filter the results by the card number.
filter_date_modified string No

Filter the results by the date modified.
page int No

Page number of the results.


Response Parameters

Name Type Description
customers object The items results.
> customer_id int The item ID.
> firstname int The parent item ID.
> lastname int The brand ID.
> name string The item name.
> company string The description of the item.
> customer_group string The plain text description of the item.
> customer_group_id string The item image URL.
> email object The item images.
> telephone string The item model code.
> card_number string The item SKU code.
> reward string The item barcode.
> date_added int The item total quantity.
> date_modified float The item 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.

 

sale/customer/getReward

This gets the list of rewards records for a specific customer on the Equotix One account.

 

Path

/api/sale/customer/getReward

 

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.
customer_id int Yes

The customer ID.
page int No

Page number of the results.


Response Parameters

Name Type Description
reward float The total rewards available for the customer.
rewards object The list of rewards records.
> reward float The reward record.
> description string The description of the record.
> date_added string The date the record was added.

 

sale/customer/addReward

This adds a reward record to a specific customer on the Equotix One account.

 

Path

/api/sale/customer/addReward

 

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.
customer_id int Yes

The customer ID.
reward float Yes

The reward points to add.
description string Yes

The description of the entry.


Response Parameters

Name Type Description
success float True if added.
errors object The errors relating to the API call.

 

Related articles

Comments

0 comments

Article is closed for comments.