Skip to content

Customer

Manage the current customer's profile, addresses, and access.

Shopper sign-in

Shoppers sign in on a page hosted by Auth or in a form in your theme; either way, Auth verifies access. The SDK uses OAuth 2.0 Authorization Code with PKCE, and your store's server handles the session with these operations. See Authentication.

Operations

MethodEndpointOperation
GET/v1/customerGet customer
PATCH/v1/customerUpdate customer
POST/v1/customer/auth/configConfigure customer sign-in

Addresses

MethodEndpointOperation
POST/v1/customer/addressesCreate a customer address
GET/v1/customer/addressesList customer addresses
PUT/v1/customer/addresses/{addressId}Update customer address
DELETE/v1/customer/addresses/{addressId}Delete customer address
POST/v1/customer/addresses/{addressId}/defaultSet default address

Registration

MethodEndpointOperation
POST/v1/customer/registrationComplete customer registration
GET/v1/customer/registrationGet customer registration details

Sessions

MethodEndpointOperation
POST/v1/customer/sessionsCreate customer session
GET/v1/customer/sessions/currentGet current customer session
DELETE/v1/customer/sessions/currentDelete customer session

Last updated:

On this page