Changelog

This changelog is the source of truth for all changes to the DotApparel API.

10 May 2024

ADDED New query parameters updated_before and asc for /orders/transactions/search

• The updated_before parameter enables users to filter and retrieve a list of retail transactions that were created before a specific date.

• The asc is a boolean parameter that allows the sorting of retail transactions by saleDate in ascending order. e.g. asc=true

Now users can limit order records for a specific date range by using both updated_before and updated_after.

20 March 2024

ADDED New fields emailSubscription and smsSubscription in the customers POST and PUT requests

The POST and PUT "customers" endpoints now accept boolean fields emailSubscription and smsSubscription. If either of these fields is set to true, it will automatically override the privacy field to false.

NOTE: Both emailSubscription and smsSubscription can modify customer references in Apparel21. However, this process requires mapping configuration within DotApparel Core. If you require assistance with this configuration, please reach out to [e-mail]

08 March 2024

FIXED Both mobile and dateOfBirth attributes are optional in customer POST and PUT requests

Resolved an issue where the customer creation or update requests could fail because both the mobile and dateOfBirth attributes were mandatory in the request payload.

07 March 2024

ANNOUNCEMENT Introducing new Staff endpoints

We're thrilled to introduce new Staff endpoints equipped with pagination and filtering capabilities. This update brings improved efficiency to accessing staff data via our API.

GET /staff?email=<value>&code=<value>

GET /staff/{id}

Staff

26 July 2023

ADDED New store and loyalty fields in customers/search response payloads

Now, the GET customers/search API responses include additional data related to the "sign-up" store code and loyalty program code/name.

19 July 2023

BREAKING The updateTimeStamp field is no longer required in Customers PUT request

The updateTimeStamp field has been removed from the request payload of the Customers PUT method, as it will be handled internally.

11 July 2023

ANNOUNCEMENT Introducing new Retail Transactions and Customers endpoints with pagination and timestamp filtering support

We are introducing highly efficient API endpoints for retrieving a list of customers or retail transaction data.

GET /customers/search

GET /orders/transactions/search

The new endpoints implemented an optimised approach to enhance the speed and performance of data retrieval. The endpoints support pagination using a cursor-based approach, enabling retrieval of up to 100 records per page. They also support for querying data using a timestamp parameter, allowing for filtering based on updated records. For more detailed information and examples on how to utilise this new efficient endpoint, please refer to the API reference page.

Orders

Customers

9 July 2023

ANNOUNCEMENT Introducing Get All Payment Gateways endpoint

We added a new API endpoint for developers to easily retrieve the list of available payment gateway names, enabling them to seamlessly pick up a desired gateway when posting orders or gift vouchers to Apparel21.

5 July 2023

ANNOUNCEMENT Introducing return creation endpoint

We added a new API endpoint for developers to facilitate return creation in Apparel21. It is crucial to note that the SKU ID must be present on the original order for the return to be processed successfully. This new functionality enhances the flexibility and convenience of managing returns within Apparel21. Please refer to the Orders API documentation for detailed instructions on how to use this endpoint effectively.

Orders

ANNOUNCEMENT Introducing voucher creation endpoint

We are also introducing a new API endpoint for creating gift vouchers in Apparel21. This endpoint enables the creation of digital gift vouchers that can be sent to customers via email. Each gift voucher includes a voucher number and PIN that customers can use for making purchases. Prior to using this endpoint, it is important to ensure the configurations for Gift Card SKU IDX, Voucher Type and Gift Voucher function are in place. Please refer to the updated Vouchers API documentation for detailed instructions on how to utilise this endpoint and complete the necessary configurations in DotApparel and Apparel21.

Vouchers

27 June 2023

ANNOUNCEMENT Introducing rewards endpoints

We have implemented new endpoints that interact with the Apparel21 Rewards feature to retrieve essential information regarding retail rewards and gifts. This data can be used to display the shopper's reward balance accurately on the website. By utilising these endpoints, the website can seamlessly retrieve and present the necessary details related to retail rewards and gifts, ensuring an up-to-date and accurate representation of the shopper's reward balance.

ANNOUNCEMENT Introducing vouchers endpoints

We are introducing new endpoints that encapsulate the functionality of the Apparel21 Gift Vouchers feature. This includes retrieving information about a gift voucher and locking a gift voucher.

26 June 2023

FIXED Retrieving customers by updated_after parameter requires the AP21 Retail API version to be 2022.1 or higher

In the event that the AP21 Retail API falls below the required version, the endpoint will respond with an empty array. To ensure proper functionality, it is crucial to verify the current API version with the merchant and initiate an upgrade if it is determined to be necessary.

23 June 2023

ADDED New contact field in customer response payloads

The customer response now includes a new field called contact which is an object including email and phones. This field is a replacement for the existing contacts field.

BREAKING The updateTimeStamp and startDate fields in customer response have some changes

More details

The updateTimeStamp is now mandatory in the response payload

The value of both fields has changed the format to YYYY-MM-DD HH:MM:SS

22 June 2023

ADDED New Shopify ID fields in customer response payloads

The customer response now includes two new fields called shopifyAdminId and shopifyLegacyId, which represents customer id in Shopify. Please note that these fields are not included in the response when using the "updated_after" parameter in a GET request.

FIXED Changing some address field names to using "camel" format in customer response payloads

The affected fields are addressLine2, state, city, postcode, and country

5 May 2023

ANNOUNCEMENT Introducing retail transactions endpoint

DotApparel API now supports looking up retail history for a shopper; including store sales, head office telephone/mail sales and web system sales.

21 April 2023

FIXED Changing customer privacy in Apparel21

DotApparel API now allows the modification of a customer's accept market status within Apparel21.

17 April 2023

ANNOUNCEMENT Introducing customer list endpoint

DotApparel API now supports returning a list of Apparel21 customers using a given update_after query parameter.

5 April 2023

ADDED New fields in API response payloads

This implementation involves updating the store, inventory, product and customer endpoints.

More details

• Modified store endpoints to return mapped Shopify location ID.

• Modified inventory endpoints to return store inventory buffer.

• Modified product endpoints to return Shopify SKU for each Apparel21 colour size.

• Modified customer endpoints to retrieve the actual reference value from DotApparel's reference cache instead of just the reference ID.

10 March 2023

ANNOUNCEMENT Introducing DotApparel API

The initial release of the API layer project.