The EvolutionX API documentation is available at and is intended for software developers. If you are looking for EvolutionX change log and release notes.

API Change Log

9 July 2021

  • Customer Custom "Alias" Product Codes support Parent and Child Customer accounts: When customer alias product codes are added to a parent customer account (API Docs to Add Customer Custom Product Codes) they will be available for view and search for users logged into a child customer account. This makes it much easier to sync and manage this content in one top-level record for the customer. If needed you can still also write customer alias product codes to the child customer record too.

14 Apr 2021

7 Apr 2021

30 Mar 2021

  • Orders: Added a new field for order line id in order items data. The field name is line_id.

26 Mar 2021

  • Customer Parent ID added: customer.parent_id is now available for Customer Create & Update. You can set a parent for any customer but only two levels are allowed. A customer record can be a parent or a child but not both.

23 Mar 2021:

  • Create or Update Pricing Item: Added a new field in Create or Update Pricing Item. The field name is is_contract. When set to true, the set of items should appear as contract items for the specified customer.

19 Mar 2021:

  • Orders: Added new alternative PO field in orders. The field name is alternative_po.

  • Open quotes: Added new alternative PO field in quotes. The field name is alternative_po.

26 Nov 2020:

  • Open quotes: New endpoint to retrieve list of Open Quotes

  • Orders: Added new points_redeemed and points_added attributes

  • Customers: Added new points_pending and points_balance attributes

02 Oct 2020:

  • Self Managed API Keys — You can now issue and delete your own API keys and give them a description. Just find the "API Keys" menu in the Developer module. Note that any existing users with permission for the Admin Users module can manage access to the Developer module.

  • List All Customers (GET): We have released more attributes under the account manager and added a new attribute called account_manager_list. The account_managers is an array of all account managers. The first manager id listed it considered the primary account. The Create a customer (POST) request only supports the addition of one id. To add multiple account managers use the Update Account Managers List (PUT).

28 August 2020:

14 July 2020:

26 June 2020:

  • Catalog Containers: New endpoints to add and remove customers from catalog containers. The customer array in catalog container will replace all the existing customers of that container. Containers are allowed to be created without customers now.

7 May 2020:

  • Products: Fixed query to get the correct pricing.

24 April 2020:

  • Orders: Changed items customise_id type to string.

23 April 2020:

26 February 2020: 

  • Orders: Added new price fields in items. These fields are "per_pack", "per_order_qty", "price_per", "item_price_raw".

04 February 2020: 

  • Orders: Added new "customise_id" field in items.

20 January 2020: 

  • Addresses: Added required validation for "address line 1" and "country" fields. "State" and "Zip" fields will be required based on the country 

14 January 2020: 

15 November 2019: 

12 November 2019: 

01 November 2019: 

29 October 2019: 

  • Orders: Added new gateway fields on order object.

16 October 2019: 

07 August 2019: 

  • Orders: Improved descriptions on the order item title.

02 August 2019: 

9 July 2019:
Added /addresses endpoint to retrieve all addresses in the store

3 July 2019:
Added type_id 3 when creating/updating a catalog container, meaning the catalog container applies to All Accounts

19 June 2019:
Added Branch Code to the order object. Until now only the id was being returned, now both id and code are being returned.

18 June 2019:
Order additions:

  • subtotal_with_discount: this field represents the subtotal of the order with any discount applied.

  • source: this is the source of the order. Please refer to for a list of sources

  • shipping label: the shipping label is the text the customer sees in the checkout process. This field is now available in both creation and update.

  • order api managed: until now any change to billing/shipping or to the items in the order would have caused the order to be marked as "api managed", meaning that from the Admin it couldn't have been edited. Now updating the order seller_reference causes the same behaviour.

  • unprocessed orders, new filter: now unprocessed orders can be filtered by source

  • customer email is not anymore a required field. It's been validated as an email address, you can now avoid to pass this field if you are creating an order with a customer that doesn't have a valid email address

3 May 2019:
Account Manager List Query by Code:  In the admin the list of Account Manger records have a "code" field which can be queried in the API using the "seller_reference" query parameter.

30 April 2019:
Customer object supports Branch ID:  The branch ID field and branch object is supported in the customer object.  This is used for setting the default branch for a customer account.  Passing null will unset the branch from the customer (exclude the field to make no change).

24 April 2019:
Branch List added Code field: This can be used as an external reference (similar as seller reference)

12 March 2019:
Tracking Link: The limit of 255 has been removed, now 2000 character limit.

14 Feb 2019:
Customer Product Codes: The customer product codes feature has been rolled out
Create Child Products: Ability to create child products give a parent
Update Products: Ability to update products outside of catalog_id 1000
Delete Products: Ability to delete your own products

7 Feb 2019:
Products: You can now filter the product list by using multiple sku's just like id's
Product Labels:You can now see what labels are assigned to products and add / delete to these as you see fit.
Product Health Flag & Description: Two new fields have been added to the product

5 Feb 2019:
Account Managers: You can now list account managers and assign them to customer accounts.

4 Feb 2019:
One shot order updates. Previously you needed to update orders in segments, now you can update an entire order at once.

18 Jan 2019:
Reset Processed Orders: You can now reset processed orders 

19 Dec 2018:

Inventory Location List: You can now query your inventory location list.

17 Dec 2018:

Address type concept has been introduced, type_id: 0 = Both, type_id: 1 = Shipping, type_id: 2 = Billing 

This means you can now define the type of address making them more manageable if you are dealing with hundreds of addresses, setting address restrictions, etc.

13 Dec 2018:

This is a major feature release regarding the creation and updating of order records via the API. Here is a break down of what is new:

  • List All Orders: Introduced a new query parameter api_managed, meaning you can now filter for api_managed orders 

  • Create An Order: Allows you to create an entire order record in one shot. These orders will inherit the api_managed: true value meaning that they will not be editable via the admin panel only through the API.

  • Update Order Header: An endpoint which allows you to update any top level order information i.e. customer, billing_address, shipping_address, branch, etc. Note: If you update the shipping or billing addresses of a normal system order, that order will be converted to an API Managed order meaning you won't be able to manage via the admin panel anymore.

  • Bulk Update Order Header: An endpoint which allows you to batch update the order header of several orders at a time. Current limit is 10.

  • Update Order Payment: Several more fields have now been exposed and are updatable. 

  • Create Order Shipping: You can add shipping records to existing orders.

  • Update Order Shipping: Several more fields exposed to give you full access to shipping values.

  • Update Order Line Items: This request will allow you to update the order line items. You must however provide all line items as this request will clear any line items you have currently. Note: Updating line items will result in your order inheriting the api_managed: true value.

23 Nov 2018:

  • Users: role_id field is no longer required when creating an account user, if role_id is not found the user will inherit the 'Business Default Role' set in the admin panel.

19 Nov 2018

  • Customers: Introduced new 'admin_email' field. The accounts admin email, if left empty this will automatically inherit the email address of the first user you add to the account.

14 Nov 2018

  • Orders: Added 'ip' field to list, this contains the users ip address 

7 Nov 2018

  • Ability to mass delete Pricing Items 

6 Nov 2018

15 Oct 2018

  • Roles: Module released in full

  • Customers: Live pricing flag introduced to customers object

  • Addresses: Removed required validation for 'city' field 

Did this answer your question?