BrainerceCustomers
Brainerce API reference: every customers operation, with its method, path and a page of its own.
Customers represent shoppers who have created an account in your store. A customer carries email, addresses, OAuth provider connections, saved payment methods, and order history. Use these endpoints to manage customer profiles, look up orders, and run the customer authentication flow (login, register, password reset, OAuth).
Customers operations
| Method | Endpoint | Operation |
|---|---|---|
POST | /vc/{connectionId}/customers/register | Register customer |
POST | /vc/{connectionId}/customers/login | Sign in customer |
POST | /vc/{connectionId}/customers/forgot-password | Request password reset (Storefront) |
POST | /vc/{connectionId}/customers/reset-password | Reset password with token (Storefront) |
GET | /vc/{connectionId}/customers/me | Get customer profile |
PATCH | /vc/{connectionId}/customers/me | Update customer profile |
GET | /vc/{connectionId}/customers/me/checkout-prefill | Get checkout prefill data |
GET | /vc/{connectionId}/customers/me/cart | Get customer cart |
GET | /vc/{connectionId}/customers/me/addresses | List customer addresses |
POST | /vc/{connectionId}/customers/me/addresses | Add customer address |
PATCH | /vc/{connectionId}/customers/me/addresses/{addressId} | Update customer address |
DELETE | /vc/{connectionId}/customers/me/addresses/{addressId} | Delete customer address |
GET | /vc/{connectionId}/customers/me/orders | List customer orders |
GET | /vc/{connectionId}/customers/me/orders/{orderId}/downloads | List order downloads |
POST | /vc/{connectionId}/customers/verify-email | Verify email |
POST | /vc/{connectionId}/customers/resend-verification | Resend verification email |
GET | /vc/{connectionId}/oauth/providers | List o auth providers |
GET | /vc/{connectionId}/oauth/{provider}/authorize | Get o auth authorize url |
GET | /vc/{connectionId}/oauth/{provider}/callback | Handle o auth callback |
GET | /vc/{connectionId}/customers/me/oauth-connections | List customer o auth connections |
POST | /vc/{connectionId}/oauth/{provider}/link | Link o auth provider |
DELETE | /vc/{connectionId}/oauth/{provider}/link | Unlink o auth provider |
GET | /vc/{connectionId}/contact-forms | List contact forms |
GET | /vc/{connectionId}/contact-forms/{formKey} | Get contact form schema |
POST | /vc/{connectionId}/inquiries | Create inquiry |
POST | /vc/{connectionId}/marketing/subscribe | Subscribe to marketing email |
GET | /vc/{connectionId}/newsletter-benefit | Read the newsletter signup benefit |
GET | /vc/{connectionId}/customers/me/wishlist/keys | List every saved item (ids only) |
GET | /vc/{connectionId}/customers/me/wishlist | List saved items, paginated (ids only) |
POST | /vc/{connectionId}/customers/me/wishlist | Save an item |
DELETE | /vc/{connectionId}/customers/me/wishlist | Remove a saved item |
POST | /vc/{connectionId}/customers/me/wishlist/merge | Merge the browser list into the account |
GET | /stores/{storeId}/newsletter-benefit | Read the active newsletter signup benefit |
POST | /v1/customers | Create a new customer |
GET | /v1/customers/{id} | Get a customer by ID |
PATCH | /v1/customers/{id} | Update a customer |
GET | /v1/customers/by-email | Get a customer by email |
POST | /v1/customers/login | Customer login |
POST | /v1/customers/register | Customer registration |
POST | /v1/customers/forgot-password | Request password reset (Public API) |
POST | /v1/customers/reset-password | Reset password with token (Public API) |
GET | /v1/customers/{id}/addresses | Get customer addresses |
POST | /v1/customers/{id}/addresses | Add a customer address |
PATCH | /v1/customers/{id}/addresses/{addressId} | Update a customer address |
DELETE | /v1/customers/{id}/addresses/{addressId} | Delete a customer address |