Orders
Last updated
Was this helpful?
Last updated
Was this helpful?
Scope: visitor and above
This endpoint retrieves retail transaction details and utilises pagination with a cursor-based approach, allowing for a maximum of 100 transactions per page.
You have the option to include a timestamp parameter to filter the results and retrieve transactions that occurred after the specified timestamp. If no timestamp is provided, all retail transactions are returned without any time-based filtering.
The endpoint supports cursor pagination, where a cursor value is returned in the response, enabling navigation through the transaction results. The maximum number of transactions per page is limited to 100.
To retrieve the list of retail transactions which have been changed after the timestamp (e.g. 2023-04-10T00:00:00)
To retrieve the list of retail transactions which have been changed before the timestamp (e.g. 2023-04-10T00:00:00)
Returns the retail transactions that come after the specified cursor
Sort the retail transactions in ascending order based on the saleDate field
An alias name that represents a particular brand that is using the API
Scope: visitor and above
Retrieve all order of a customer in Apparel21
The Apparel21 Person ID
An alias name that represents a particular brand that is using the API
Scope: visitor and above
Retrieve a single order in Apparel21
The Apparel21 Person ID
The Apparel21 Order ID
An alias name that represents a particular brand that is using the API
Scope: visitor and above
This endpoint retrieve a person's sales history across various channels, including in-store, telephone/mail orders, and web system sales. This endpoint is designed to display a comprehensive record of all sales that have been dispatched or picked up by the shopper. It is important to note that any items that are still on order will not be visible through this feature.
The response is split into three main sections: Transaction Header, Transaction Detail, and Transaction Discount Detail. The Transaction Header provides key information about the transaction, including the type of transaction, the date and location it occurred, and the currency used. The Transaction Detail section contains detailed product information at the SKU level, including product codes, size, color, and pricing. The Transaction Discount Detail section includes information on any discounts applied, such as the type, reason, and amount.
The endpoint does NOT include the following types of transactions made by a person: wholesale orders, debtor sales, customer orders, and account payments.
The Apparel21 Person ID
An alias name that represents a particular brand that is using the API
Scope: visitor and above
This endpoint will retrieve a list of available payment gateway names.
The returned information is typically used when posting orders or gift vouchers in Apparel21.
An alias name that represents a particular brand that is using the API
Scope: maintainer and above
This endpoint allows for the creation of orders in the Apparel21 system.
The endpoint accepts either Apparel21 SKU id or Shopify SKU. When sku id is not provided, the endpoint has the ability to search for SKU IDs in DotApparel based on SKUs. Additionally, the endpoint can map freight options from DotApparel based on shipping method titles. In order to use the endpoint, the user must provide a valid gateway name that matches the settings in DotApparel.
To begin using the endpoint, the user must first search for the Apparel21 person ID using the customer endpoints. Once the person ID has been located, the user can then submit a JSON payload containing the person ID to create a new order in the Apparel21 system. This endpoint is designed to streamline the process of creating orders in Apparel21 by allowing users to easily locate the necessary information and submit it in a convenient format.
An alias name that represents a particular brand that is using the API
#100173152The date and time of the order
2023-03-02T14:31:42Special instructions for the delivery
Indicates if the prices include tax
trueThe field indicates the option for unattended delivery for the order. It can be set to either "AuthorityToLeave" or "None". If the field is not provided, it will default to "None".
AuthorityToLeaveinfo@example.com(04) 8375 9586The StoreId field represents the identifier of the store from which the product will either be picked up or despatched. This field is required when the customer chooses to collect the order from a retail store as a ClickAndCollect order. For DespatchFromStore orders, this field is optional.
This field indicates the type of despatch method for an order. It could be set to one of the following values: ClickAndCollect, DespatchFromStore, DespatchFromWarehouse, or Blank. If the field is left blank, it will default to a normal warehouse despatch order. The DespatchType field is mandatory only when a pick-up location ID is provided.
DespatchFromWarehouseScope: maintainer and above
This endpoint allows you to create returns in Apparel21. You can specify the SKU ID directly or provide a SKU to search for the SKU ID in DotApparel. The SKU ID must be present on the original order for the return to be processed successfully.
An alias name that represents a particular brand that is using the API
The apparel21 order id
100423The apparel21 person id
96996If an orderNumber is provided, it will be recognised as the Customer Order Number within the Apparel21. However, if the field is left empty, the API will automatically generate a unique order number.
#110096-RThe reference for the original order. All returns must be posted against an original web order.
#110096Typically, this particular element is not frequently utilized. However, it can be provided with a value of "false" to indicate that the returned item will not be returned to the warehouse. In this case, an automatic customer refund will be initiated to complete the return process, and a stock adjustment will be made to account for the item not being sent back. If no value is provided, the default behavior is considered as "true". In other words, a pending return or exchange order will be created in Apparel21, awaiting the item's receipt in the warehouse.
true