This update will become available to all users by the 10th of May 2022.
New Endpoints
Create and Update Customer Data
You can now create and update customer data using the Retail Express Unified API. In addition to that, using these new methods you can even update customer details not previously available through the legacy APIs:
- Add customers to Price Groups
- Update Survey Segment answers
- Retrieve Loyalty Points Balances (we currently don't allow for points to be updated via API - if this is important to you please vote for this feature)
New endpoints:
- POST /customers
- PUT /customers/{id}
- GET, POST, PUT, DELETE /customers/{id}/deliveryaddresses - allows for retrieval, creation, updates, and deletion of delivery addresses for a given customer
- GET /customersurveysegments - allows for retrieval of customer survey segments and segment options (questions and answers) as configured in settings
- GET /customertypes - allows for retrieve of customer types as configured in settings
Back to top
New Parameters
GET /customers
We've added a new 'order_by' parameter which allows results to be ordered by:
- id
- customer_number
- email, mobile
- first_name
- last_name
- company
- customer_type_name
- receive_email
- receive_post
- receive_sms
- loyalty_program_enabled
- loyalty_points_available
- loyalty_points_available_value
- loyalty_points_redeemed
- loyalty_points_to_date
- account_customer_enabled
- account_customer_payment_terms
- price_group_standard
- price_group_fixed
- home_outlet_name
- custom_reference
- created_on
- modified_on
GET /orders
We've added a new 'filter_by' parameter which allows results to be filtered by:
- order_number
- order_status_id
- sales_channel_id
- outlet_id, customer_id
- customer_number
- customer_email
- sales_person_id.
Various operators are available and filters can be combined - please see the Developer API documentation for more details.