> For the complete documentation index, see [llms.txt](https://developers.dotapparel.com.au/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.dotapparel.com.au/api/changelog.md).

# Changelog

{% hint style="info" %}
This changelog is the source of truth for all changes to the DotApparel API.
{% endhint %}

### 10 May 2024

<mark style="color:green;">**`ADDED`**</mark> **New query parameters&#x20;**<mark style="color:blue;">**`updated_before`**</mark>**&#x20; and&#x20;**<mark style="color:blue;">**`asc`**</mark>**&#x20;for** `/orders/transactions/search`

* The <mark style="color:blue;">**`updated_before`**</mark> parameter enables users to filter and retrieve a list of retail transactions that were created before a specific date.
* The <mark style="color:blue;">**`asc`**</mark> is a <mark style="color:orange;">`boolean`</mark> parameter that allows the sorting of retail transactions by <mark style="color:blue;">**`saleDate`**</mark> in ascending order. e.g. `asc=true`

Now users can limit order records for a specific date range by using both <mark style="color:blue;">**`updated_before`**</mark> and <mark style="color:blue;">**`updated_after`**</mark>.

### 20 March 2024

<mark style="color:green;">**`ADDED`**</mark> **New fields&#x20;**<mark style="color:blue;">**`emailSubscription`**</mark>**&#x20;and&#x20;**<mark style="color:blue;">**`smsSubscription`**</mark>**&#x20;in the customers `POST` and `PUT` requests**

The `POST` and `PUT` "customers" endpoints now accept <mark style="color:orange;">`boolean`</mark> fields emailSubscription and smsSubscription. If either of these fields is set to true, it will automatically override the privacy field to false.&#x20;

**NOTE:** Both <mark style="color:blue;">`emailSubscription`</mark> and <mark style="color:blue;">`smsSubscription`</mark> 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 <mark style="color:green;">**<support@dotapparel.com.au>**</mark>

### 08 March 2024

<mark style="color:purple;">**`FIXED`**</mark>**&#x20;Both&#x20;**<mark style="color:blue;">**`mobile`**</mark>**&#x20;and&#x20;**<mark style="color:blue;">**`dateOfBirth`**</mark>**&#x20;attributes are optional in customer `POST` and `PUT` requests**

Resolved an issue where the customer creation or update requests could fail because both the <mark style="color:blue;">**`mobile`**</mark> and <mark style="color:blue;">**`dateOfBirth`**</mark> attributes were mandatory in the request payload.

### 07 March 2024

<mark style="color:blue;">**`ANNOUNCEMENT`**</mark>**&#x20;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}`

{% content-ref url="/pages/8UYGRbFSqkfkLZB2EIKj" %}
[Staff](/api/reference/staff.md)
{% endcontent-ref %}

### 26 July 2023

<mark style="color:green;">**`ADDED`**</mark>**&#x20;New store and loyalty fields in&#x20;**<mark style="color:blue;">**`customers/search`**</mark>**&#x20;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

<mark style="color:red;">**`BREAKING`**</mark>**&#x20;The&#x20;**<mark style="color:blue;">**`updateTimeStamp`**</mark>**&#x20;field is no longer required in Customers PUT request**

The  <mark style="color:blue;">`updateTimeStamp`</mark>  field has been removed from the request payload of the Customers PUT method, as it will be handled internally.&#x20;

### 11 July 2023

<mark style="color:blue;">**`ANNOUNCEMENT`**</mark>**&#x20;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.&#x20;

`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.

{% content-ref url="/pages/cM3sCjzo6LPTVGtbzSH7" %}
[Orders](/api/reference/orders.md)
{% endcontent-ref %}

{% content-ref url="/pages/12BaHvpNerxhVhmj1Edi" %}
[Customers](/api/reference/customers.md)
{% endcontent-ref %}

### 9 July 2023

<mark style="color:blue;">**`ANNOUNCEMENT`**</mark>**&#x20;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.&#x20;

### 5 July 2023

<mark style="color:blue;">**`ANNOUNCEMENT`**</mark>**&#x20;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.

{% content-ref url="/pages/cM3sCjzo6LPTVGtbzSH7" %}
[Orders](/api/reference/orders.md)
{% endcontent-ref %}

<mark style="color:blue;">**`ANNOUNCEMENT`**</mark>**&#x20;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.

{% content-ref url="/pages/v499opxk0WQdYuOPK5YK" %}
[Vouchers](/api/reference/vouchers.md)
{% endcontent-ref %}

### 27 June 2023

<mark style="color:blue;">**`ANNOUNCEMENT`**</mark>**&#x20;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.

<mark style="color:blue;">**`ANNOUNCEMENT`**</mark>**&#x20;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

<mark style="color:purple;">**`FIXED`**</mark>**&#x20;Retrieving customers by&#x20;**<mark style="color:blue;">**`updated_after`**</mark>**&#x20;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

<mark style="color:green;">**`ADDED`**</mark>**&#x20;New&#x20;**<mark style="color:blue;">**`contact`**</mark>**&#x20;field in customer response payloads**

The customer response now includes a new field called <mark style="color:blue;">`contact`</mark> which is an object including email and phones. This field is a replacement for the existing <mark style="color:blue;">`contacts`</mark> field.

<mark style="color:red;">**`BREAKING`**</mark>**&#x20;The&#x20;**<mark style="color:blue;">**`updateTimeStamp`**</mark>**&#x20;and&#x20;**<mark style="color:blue;">**`startDate`**</mark>**&#x20;fields in customer response have some changes**

<details>

<summary>More details</summary>

The <mark style="color:blue;">`updateTimeStamp`</mark> is now mandatory in the response payload

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

</details>

### 22 June 2023

<mark style="color:green;">**`ADDED`**</mark>**&#x20;New Shopify ID fields in customer response payloads**

The customer response now includes two new fields called <mark style="color:blue;">`shopifyAdminId`</mark> and <mark style="color:blue;">`shopifyLegacyId`</mark>, which represents customer id in Shopify. Please note that these fields are not included in the response when using the "<mark style="color:blue;">`updated_after`</mark>" parameter in a GET request.&#x20;

<mark style="color:purple;">**`FIXED`**</mark>**&#x20;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

<mark style="color:blue;">**`ANNOUNCEMENT`**</mark>**&#x20;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

<mark style="color:purple;">**`FIXED`**</mark>**&#x20;Changing customer privacy in Apparel21**

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

### 17 April 2023

<mark style="color:blue;">**`ANNOUNCEMENT`**</mark>**&#x20;Introducing customer list endpoint**

DotApparel API now supports returning a list of Apparel21 customers using a given <mark style="color:blue;">`update_after`</mark> query parameter.

### 5 April 2023

<mark style="color:green;">**`ADDED`**</mark>**&#x20;New fields in API response payloads**

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

<details>

<summary>More details</summary>

* 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.

</details>

### 10 March 2023

<mark style="color:blue;">**`ANNOUNCEMENT`**</mark>**&#x20;Introducing DotApparel API**

The initial release of the API layer project.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developers.dotapparel.com.au/api/changelog.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.