Developer Guides
  • Introduction
    • Welcome
  • Core
    • Overview
    • Frontend
      • Implementation & Testing
      • Using the API endpoints
      • Gift cards
        • Gift Card validation API (Optional)
      • Check stock
      • Sibling products
      • Rewards program
      • Customer signatures
      • Retail transactions
      • Shopify Local Pick-up
  • API
    • Overview
    • Quick Start
    • Accounts
    • Changelog
    • Reference
      • Customers
      • Inventory
      • Orders
      • Products
      • Rewards
      • Stores
      • Vouchers
      • Staff
Powered by GitBook
On this page
  • Customer signatures
  • Using the API endpoints

Was this helpful?

Export as PDF
  1. Core
  2. Frontend

Retail transactions

Being a POS platform, Apparel21 is able to capture physical in-store orders, as well as web orders. If the POS operator collects the customers' personal information at checkout, then the order will be attached to the Apparel21 “person” record associated with that customer.

If the orders are attached to the relevant person in Apparel21 (using the same email address as the one used online), then it’s possible to show the customer a list of their in-store orders on the website.

DotApparel achieves this by exposing an API endpoint which when called with the customer email address and a special signature, a live request is made to Apparel21 to fetch the retail transactions, before returning them back to the website frontend for display.

Customer signatures

All customer-specific endpoints in DotApparel are secured using an HMAC signature, which consists of the customer email address, signed using HMAC and a shared secret. This mechanism is in place such that unauthorized users cannot make requests for email addresses that do not belong to them.

You should read the customer signatures guide before proceeding.

Using the API endpoints

If you’re using the API endpoints, then you can make a POST request to /apps/dotapparel/api-retailTransactions with the following JSON payload.

{
  "email": "foo@example.com",
  "signature": "foobar"
}
PreviousCustomer signaturesNextShopify Local Pick-up

Last updated 1 year ago

Was this helpful?