Skip to main content
API Change Log

Updates to the API are listed here in order of most recent.

Séamus Diamond avatar
Written by Séamus Diamond
Updated over a week ago

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

24 April 2024

  • Shared Quicklists

    • Added new endpoinsts for Shared Quicklists (API Docs).

12 April 2024

  • Products - Product record - List All products

    • Added a new field, skus_in_json, which, when set to true, indicates that SKUs are provided in JSON format (API Docs).

09 April 2024

  • Orders - Order record - Item Data Array

    • Support for points_redeemed attribute per item line

    • Support for points_added attribute per item line

06 March 2024

  • Categories - List All Categories

    • Maximum limit increased to 2000 (API Docs).

04 March 2024

  • Orders - Order record - List orders

    • Endpoint now supports seller_reference parameter (API docs).

  • Products - Product record - Create overlay record

    • Creating/updating the overlay record for managed products is supported via query parameter update_managed_product_overlay=1 (API docs).

08 February 2024

  • Category Verticals - List All Category Verticals

    • Added new endpoint to retrieve all category verticals for the store.

  • Categories - List All Categories

    • Supports filtering by Category Vertical (classification_id).

25 January 2024

  • Customer - Users - User settings

    • Supports update of is_allowance, allowance_remaining and allowance_expires for On Account Status.

08 November 2023

  • Customer - Quicklist - Items

    • Added protection to only add enabled items to a quicklist.

10 October 2023

  • Customer - Quicklist - Is Locked

    • New flag to determine if a quicklist is locked for editing or not.

21 August 2023

  • Order Record

    • New field to shipping object forward_shipping which specifies date and time selected by the customer during checkout.

16 August 2023

  • Customer - Labels - Add Labels To Customer

    • Add Labels To Customer endpoint now allows the use of labels from a parent store.

09 August 2023

  • Catalogs - Containers - Index Catalog Container

    • Added new endpoint to request indexing for a catalog container.

02 August 2023

  • Inventory - Bulk Update inventory by Seller Reference

    • Limit increased from 10 to 150.

25 July 2023

  • Inventory - Bulk create or update inventory

    • Limit increased from 10 to 150.

19 June 2023

  • Products - Product record - Create Child Products

    • Supports the creation of child products from Managed Products.

  • Products - Product record - Update Products

    • New field is_autoupdate to keep propagation enabled when updating a child product.

    • Supports update of cost_price, catalog_description, global_description and enabled for Managed Products.

16 June 2023

  • Order Record - List Orders

    • Add new field to data.items "cost_center_seller_reference" referring to the item cost center seller reference.

27 March 2023

  • POST/PUT Products

    • Supports attribute popularity_score, where the value will override the score set by store activity.

16 March 2023

21 February 2023

  • POST/PUT Customers Users

    • New field set_as_default supported. When set to true the new/updated user will be set as default user of the correspondent customer account.

25 January 2023

  • PUT User Settings

    • New field po_mask on the user order settings (requester_settings.order_settings.po_mask) that allows updating the default Order PO Structure for a user.

13 December 2022

  • POST/PUT Customers

    • Deprecated the credit_account field but still supported. This has been replaced by a new field using an integer value called credit_account_status.

    • New field credit_account_status accepts a new option (value 2) "Inherit from parent".

07 September 2022

  • POST/PUT products

    • Changed attribute maximum_order validation to accept value greater than or equal to minimum_order.

02 August 2022

  • POST/PUT Products

    • Supports attribute additional_categories, where product categories can be updated through the category id as well as through the supplier reference.

15 June 2022

  • Customers POST/PUT addresses will require either line_1 or line_2

  • POST/PUT product attributes - Now the all the existing attributes can be deleted if is_replace=true and the data array is empty

15 May 2022

  • New field is_replace supported in POST /product/{id}/media/content. If this field is true, the content media list of the product will be replaced by the list provided in the payload.

6 May 2022

Added support for Supplier Seller Reference and Supplier Parent Seller Reference to categories. When a distributor or wholesaler is providing a taxonomy, EvolutionX can use the supplier reference to store their IDs with the categories in the store. Similar to a seller reference it allows developers to use the third-party ID to find the Evolution X category ID.

Editing the values should be done in the Admin categories editor or Admin category imports.

    • supports query parameters supplier_reference and supplier_parent_reference to find a category by exact match of the value searched. Note that it may return more than one, especially when using supplier_parent_reference.

    • returns the values for supplier_reference and supplier_parent_reference in the response

10 March 2022

New endpoints for inventory. These are recommended over older methods and allow you to send inventory on hand quantity using the seller reference of SKU and Location Seller Reference. EvolutionX API then looks up the suppliers with that SKU and Location and write the necessary records.

28 February 2022

  • New field supported in POST /customers/{customerId}/addresses

2 February 2022

  • New attributes supported on the POST: /products/{itemId}/media/content:

    • data.type_id

    • data.title

    • data.priority

  • New attributes supported on the POST: /products/{itemId}/media/images

    • data.title

    • data.alt

    • data.priority

  • Added new information returned when viewing a product GET: /products/{itemId}

    • Media.additional_images: image_title, alternative_text, priority

    • Media.videos: title, priority, create_at, update_at

    • Media.documents: title, priority, create_at, update_at, type_id

20 January 2022

  • New parameter added in endpoint POST: /{customerId}/addresses called set_as_default with values:

    • true: The address will be set as the default address for the customer

    • false: The address will not be set as default for the customer

  • New parameter added in endpoint PUT: /{customerId}/addresses/{addressId} called set_as_default with values:

    • true: The address will be set as the default address for the customer

    • false: The address will not be set as default for the customer

    If the new parameter is not included at all for the POST request, the address created will be assigned as default for the customer, if the customer has not a default address already set.

10 January 2022

  • New endpoints for Remittances

    • GET: /remittances : Return all remittances

    • PUT: /{remittance_id} : Update a remittance by id

15 December 2021

  • New API home on Postman: To make life easier for all the developers that use our API, we have now migrated our API to a Postman Collection. This allows you to download the full API inclusive of endpoints and setup into your local Postman workspace.

    • Download the full API into your Postman Collection

10 Nov 2021

02 Nov 2021

26 Oct 2021

  • Third party Data: Some integrations require data to be passed from that system to your EvoX store. Now that data has a place to live and be delivered through our API. It's currently available in the order object and will be rolled-out in other endpoints where needed.

07 Oct 2021

22 Sept 2021

  • Customers Reward Status: The rewards_status "rewards_status": 0 is now available to be updated GET, POST and PUT requests. This allows you to create customers and set their reward_status in the same request.

  • Customers Enabled Status: Use the "enabled": true to set your customer accounts as enabled or disabled. Available for GET, POST and PUT requests.

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?