Customers
Last updated
Was this helpful?
Last updated
Was this helpful?
Scope: visitor and above
This endpoint retrieves customer details and implements pagination using a cursor-based approach.
You can optionally include a timestamp parameter to filter the results based on customer records updated after the provided timestamp. If no timestamp is provided, all customer details are returned without any time-based filtering.
The endpoint supports cursor pagination, where a cursor value is included in the response to facilitate navigation through the results. The maximum number of records per page is limited to 100.
To retrieve the list of customers which have been changed after the timestamp (e.g. 2023-04-10T00:00:00)
Returns the customers that come after the specified cursor
An alias name that represents a particular brand that is using the API
Scope: visitor and above
This endpoint retrieves customer details by accepting a parameter of either a valid email address or a specific timestamp.
If an email address is provided, the endpoint checks that the email address is valid and associated with an existing customer record, and returns the person records that match the email entered.
If a specific timestamp is provided, the endpoint checks that the timestamp is valid and no more than 7 days ago, and returns a list of person records that have been updated after the timestamp. It is important to be aware that this parameter requires the Apparel21 Retail API version 2022.1 or a more recent version.
The email address of the customer
To retrieve the list of customers which have been changed after the timestamp (e.g. 2023-04-10T00:00:00)
An alias name that represents a particular brand that is using the API
Scope: visitor and above
This endpoint retrieves customer details by an associated Apparel21 Person ID.
The endpoint checks that the email address is valid and associated with an existing customer record. If the ID is valid, the endpoint retrieves the customer's record and returns a success message with a JSON object containing their information.
The Apparel21 Person ID
An alias name that represents a particular brand that is using the API
Scope: maintainer and above
This endpoint creates new customers by accepting required information including first name, last name, and unique email address, as well as optional contact number and address.
The endpoint checks that all required fields are present and that the email is not already associated with an existing customer. If the required information is valid, the endpoint creates a new customer record and returns a success message with a JSON object containing the new customer's ID and their information.
NOTE: The endpoint accepts boolean fields emailSubscription and smsSubscription. If either of these fields is set to true, it will automatically override the privacy field to false. Both of these fields 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 support@dotapparel.com.au
An alias name that represents a particular brand that is using the API
JohnSmithThe field will be set to false if either emailSubscription or smsSubscription is true.
falsefalsefalseinfo@example.com(04) 8375 9586Scope: maintainer and above
This endpoint updates existing customers by accepting optional information including first name, last name, contact number, and address.
The endpoint checks that the first name and last name are not empty before updating the customer record. If the required information is valid, the endpoint updates the customer's record and returns a success message with a JSON object containing the customer's ID and their updated information.
NOTE: The endpoint accepts boolean fields emailSubscription and smsSubscription. If either of these fields is set to true, it will automatically override the privacy field to false. Both of these fields 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 support@dotapparel.com.au
The Apparel21 Person ID
An alias name that represents a particular brand that is using the API
JohnSmithThe field will be set to false if either emailSubscription or smsSubscription is true.
falsefalsefalseinfo@example.com(04) 8375 9586