Articles in this section

See more

Sale / Order

Order

The available APIs for orders are explained below.

sale/order/add

This adds an order to the Equotix One account.

 

Path

/api/sale/order/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.
customer_id string Yes The order customer ID. Use "0" to create a new customer.
firstname string Yes

The order first name.
lastname string Yes

The order last name.
company string Yes

The order company.
email string Yes

The order email.
telephone string Yes

The order telephone.
telephone_2 string Yes

The order telephone 2.
date_ordered string Yes

The order date.
address_1 string Yes

The order address 1.
address_2 string Yes

The order address 2.
city string Yes

The order city.
postcode string Yes

The order postcode.
country string Yes

The order country.
zone string Yes

The order zone.
shipping_method string Yes

The order shipping method.
shipping_date string Yes

The order shipping date.
shipping_tracking string Yes

The order shipping tracking.
currency string Yes

The order currency code. Must be already added into the account.
currency_value string Yes

The order currency value.
payment_method string Yes

The order payment method.
total float Yes

The order total.
comment string Yes

The order comment.
products object Yes

The items in the order.
> item_id int Yes

The item ID.
> name string Yes

The item name.
> model string Yes

The item model code.
> sku string Yes

The item sku code.
> quantity int Yes

The item quantity.
> price float Yes

The item price.
> cost float Yes

The item cost.
split_payment int Yes

Set to "1" is this order is paid with multiple payment methods.
payments object No

Required only if split payment is "1". Payments must sum up correctly.
> payment_method string Yes

Payment method name.
> total float Yes

Payment method total.
deduct int No

"1" to deduct the item from the inventory, "0" to not deduct.
payment_method_id int No

Set the payment method and the default order status using the payment methods available in the account.
totals object No

The order totals for shipping and other discounts.
> name string Yes

The order total name.
> price float Yes

The order total price.
> sort_order int Yes

Sort order of the order total.


Response Parameters

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

 

sale/order/edit

This edits an order in the Equotix One account.

 

Path

/api/sale/order/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.
order_id int Yes

The order ID to edit.
customer_id string Yes The order customer ID. Use "0" to create a new customer.
firstname string Yes

The order first name.
lastname string Yes

The order last name.
company string Yes

The order company.
email string Yes

The order email.
telephone string Yes

The order telephone.
telephone_2 string Yes

The order telephone 2.
date_ordered string Yes

The order date.
address_1 string Yes

The order address 1.
address_2 string Yes

The order address 2.
city string Yes

The order city.
postcode string Yes

The order postcode.
country string Yes

The order country.
zone string Yes

The order zone.
shipping_method string Yes

The order shipping method.
shipping_date string Yes

The order shipping date.
shipping_tracking string Yes

The order shipping tracking.
currency string Yes

The order currency code. Must be already added into the account.
currency_value string Yes

The order currency value.
payment_method string Yes

The order payment method.
total float Yes

The order total.
comment string Yes

The order comment.
products object Yes

The items in the order.
> item_id int Yes

The item ID.
> name string Yes

The item name.
> model string Yes

The item model code.
> sku string Yes

The item sku code.
> quantity int Yes

The item quantity.
> price float Yes

The item price.
> cost float Yes

The item cost.
split_payment int Yes

Set to "1" is this order is paid with multiple payment methods.
payments object No

Required only if split payment is "1". Payments must sum up correctly.
> payment_method string Yes

Payment method name.
> total float Yes

Payment method total.
deduct int No

"1" to deduct the item from the inventory, "0" to not deduct.
payment_method_id int No

Set the payment method and the default order status using the payment methods available in the account.
totals object No

The order totals for shipping and other discounts.
> name string Yes

The order total name.
> price float Yes

The order total price.
> sort_order int Yes

Sort order of the order total.

 

Response Parameters

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

 

sale/order/delete

This deletes an order from the Equotix One account.

 

Path

/api/sale/order/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.
order_id int Yes

The order ID to delete.


Response Parameters

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

 

sale/order/get

This gets a list of credit notes or a specific credit note from the Equotix One account.

 

Path

/api/sale/order/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.
order_id int No

The order ID to search for specifically.
filter_imported_order_id string No

The channel order ID to search for specifically.
filter_customer_id int No

Filter the results by customer ID.
filter_channel_id int No

Filter the results by channel ID.
filter_name string No

Filter the results by the customer name.
filter_email string No

Filter the results by the email.
filter_telephone string No

Filter the results by the telephone.
filter_order_status string No

Filter the results by a list of order statuses, comma separated.
filter_payment_method string No

Filter the results by the order payment method.
filter_shipping_method string No

Filter the results by the order shipping method.
filter_shipping_tracking string No

Filter the results by the shipping tracking.
filter_shipping_date string No

Filter the results by the shipping date.
filter_postcode string No

Filter the results by the postcode.
filter_date_start string No

Filter the results by the date type, starting from this date. Date type and date end must be set.
filter_date_end string No

Filter the results by the date type, ending at this date. Date type and date start must be set.
filter_date_type string No

Filter the results by the date type - "date_added", "date_modified" or "date_ordered".
page int No

Page number of the results.


Response Parameters

Name Type Description
orders object The orders results.
> order_id int The order ID.
> imported_order_id string The channel order ID.
> channel_id int The channel ID.
> channel string The channel name.
> payment_method string The payment method.
> customer_id int The customer ID.
> firstname string The order first name.
> lastname string The order last name.
> email string The order email.
> name string The order first name and last name merged.
> company string The order company.
> telephone string The order telephone.
> telephone_2 string The order telephone 2.
> address_1 string The order address 1.
> address_2 string The order address 2.
> city string The order city.
> postcode string The order postcode.
> country string The order country.
> zone string The order zone.
> order_status string The order status.
> order_status_id int The order status ID.
> currency string The order currency code.
> currency_value float The order currency value.
> total float The order total.
> cost float The order cost.
> shipping_method string The order shipping method
> shipping_tracking string The order shipping tracking.
> shipping_date string The order shipping date.
> date_ordered string The order date.
> date_added string The order date added.
> date_modified string The order date modified.
> comment string The order comment.
> products object The order products.
>> order_product_id float The order product ID.
>> imported_order_product_id string The imported order product ID
>> item_id int The item ID.
>> thumb string The item image URL.
>> name string The item name.
>> model int The item model.
>> sku int The item SKU.
>> quantity float The item quantity.
>> price string The item price.
>> discount float The item discount.
>> discount_platform float The item discount provided by platform. The discount above includes discount_platform.
>> total int The item total price.
>> cost float The item cost.
>> order_status_id int The order status ID for the product.
>> order_status string The order status for the product.
>> deducted boolean The item deducted status.
> payments object The list of payment methods used for this order.
>> payment_method string The payment method.
>> total float The payment method total.
> totals object The list of order totals.
>> code string The order total code.
>> name string The order total name.
>> price float The order total price.
>data object The other details that are available
total int The total number of results.

 

sale/order/getHistory

This gets a list of order histories for the credit note.

 

Path

/api/sale/order/getHistory

 

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.
order_id string Yes

The order ID.
page int No

Page number of the results.


Response Parameters

Name Type Description
order_id int The order ID.
order_status_id int The order status ID.
order_statuses object The list of order statuses tagged to the order.
total int The total number of results.
histories object The list of histories.
> order_status string The order status.
> order_status_id int The order status ID.
> user string The user who added this history.
> comment string The history comment.
> date_added string The date the history was added.
error object The errors relating to the API call.

 

sale/order/addHistory

This adds a history to the order as well as update its order status.

 

Path

/api/sale/order/addHistory

 

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.
order_id string Yes

The order ID.
order_status_id int Yes

The order status ID to update to.
comment string No

The order history comment.


Response Parameters

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

 

Related articles

Comments

0 comments

Article is closed for comments.