Customers API

Customer accounts and auth for ENAD storefronts: signup, login, email verification, password reset, JWT sessions, profiles, orders, carts, wishlists, and organisation (B2B) accounts, at https://customers.enad.io.

When to use it

It powers the “my account” pages of a storefront. A customer signs up or logs in through the storefront, receives an access and refresh token, and then reads and updates their own profile, orders, carts, and wishlists with that session. It is not for catalog management: products are managed through the Management API (https://docs.enad.io/management/management-api) and read by shoppers over the Product Search API (https://docs.enad.io/storefront/graphql).

Authentication

Two schemes, used together on carts, wishlists, and customer-group prices:

• App API key — server-to-server requests such as login, signup, order lookups, organisation creation, and file uploads send the app’s key in the api-key header.
• Customer JWT — requests on behalf of a logged-in customer send the token issued at login as Authorization: Bearer <token>; access tokens are short-lived (one hour by default) and renewed with the refresh token. All routes are prefixed with /api/v1/{app_id}/.

Auth

• POST
  Change password/api/v1/{app_id}/auth/change-password
• POST
  Login user/api/v1/{app_id}/auth/login
• POST
  Refresh token/api/v1/{app_id}/auth/refresh
• POST
  Create password reset link/api/v1/{app_id}/auth/reset-password
• POST
  Register new user/api/v1/{app_id}/auth/signup
• POST
  Create email verification link/api/v1/{app_id}/auth/verify-email
• POST
  Verify email/api/v1/{app_id}/auth/verify-email-token

Users

• POST
  Lookup user by email/api/v1/{app_id}/lookup/user
• DELETE
  Delete current user/api/v1/{app_id}/user
• GET
  Gets the user from the token/api/v1/{app_id}/user
• PATCH
  Updates the user information/api/v1/{app_id}/user
• GET
  Get user by ID/api/v1/{app_id}/users/{user_id}
• PATCH
  Update user by ID/api/v1/{app_id}/users/{user_id}

Organisations

• GET
  Get organisation by organisation number/api/v1/{app_id}/lookup/organisations/{organisation-number}
• GET
  List organisations/api/v1/{app_id}/organisations
• POST
  Register new organisation/api/v1/{app_id}/organisations
• DELETE
  Delete organisation/api/v1/{app_id}/organisations/{id}
• GET
  Get organisation/api/v1/{app_id}/organisations/{id}
• PATCH
  Patch organisation/api/v1/{app_id}/organisations/{id}
• GET
  Get organisation tree/api/v1/{app_id}/organisations/{id}/tree
• GET
  List users for an organisation/api/v1/{app_id}/organisations/{id}/users
• POST
  Add user to organisation/api/v1/{app_id}/organisations/{id}/users
• DELETE
  Remove user from organisation/api/v1/{app_id}/organisations/{id}/users/{user_id}

Orders

• GET
  List all orders for an app/api/v1/{app_id}/lookup/orders
• GET
  Get order by ID for an app/api/v1/{app_id}/lookup/orders/{id}
• GET
  Get order by reference for an app/api/v1/{app_id}/lookup/orders/reference/{reference}
• GET
  List orders for authenticated user/api/v1/{app_id}/orders
• GET
  Get order by ID for authenticated user/api/v1/{app_id}/orders/{id}
• GET
  Get order by reference for authenticated user/api/v1/{app_id}/orders/reference/{reference}

Cart

• GET
  List saved carts for authenticated user/api/v1/{app_id}/carts
• POST
  Save a new cart reference/api/v1/{app_id}/carts
• DELETE
  Delete a saved cart/api/v1/{app_id}/carts/{id}

Wishlist

• GET
  Get shared wishlist (paginated)/api/v1/{app_id}/shared/wishlists/{token}
• GET
  List wishlists for authenticated user/api/v1/{app_id}/wishlists
• POST
  Create a new wishlist/api/v1/{app_id}/wishlists
• DELETE
  Delete wishlist/api/v1/{app_id}/wishlists/{id}
• GET
  Get a particular wishlist with items./api/v1/{app_id}/wishlists/{id}
• PATCH
  Update wishlist/api/v1/{app_id}/wishlists/{id}
• DELETE
  Remove items from wishlist/api/v1/{app_id}/wishlists/{id}/items
• POST
  Add items to wishlist/api/v1/{app_id}/wishlists/{id}/items
• POST
  Create or get share token for wishlist/api/v1/{app_id}/wishlists/{id}/share
• DELETE
  Revoke wishlist share token/api/v1/{app_id}/wishlists/{id}/share/{token}

Files

• DELETE
  Delete a file/api/v1/{app_id}/files/{file_id}
• PATCH
  Patch file metadata/api/v1/{app_id}/files/{file_id}
• POST
  Upload a file/api/v1/{app_id}/files/upload

Attributes

• GET
  List attributes for an application/api/v1/{app_id}/attributes
• GET
  Get a single attribute/api/v1/{app_id}/attributes/{attribute_id}
• DELETE
  Remove attribute relationship from an organisation/api/v1/{app_id}/organisations/{organisation_id}/attributes/{attribute_id}
• POST
  Add attribute relationship to an organisation/api/v1/{app_id}/organisations/{organisation_id}/attributes/{attribute_id}
• DELETE
  Remove attribute relationship from a user/api/v1/{app_id}/users/{user_id}/attributes/{attribute_id}
• POST
  Add attribute relationship to a user/api/v1/{app_id}/users/{user_id}/attributes/{attribute_id}

Customer Groups

• GET
  Get customer group by slug/api/v1/{app_id}/customer-groups/{customer_group_slug}
• GET
  Get customer groups with paginated prices for a user or organisation/api/v1/{app_id}/customer-groups/store-groups/{store_group_id}/markets/{market_id}/prices