API Reference

Create identity

post
https://customer-identity-api-pre.b2w.app/api/Identity

Creates a customer identity. If the identity already exists, updates its data.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Identity data request.

Represents the request to create or update a customer identity.

int32
enum
required

1 = Shopify (Shopify ecommerce platform)
2 = Salesforce (Salesforce ecommerce platform)
3 = Custom (Custom third party system)
4 = PrestaShop (PrestaShop ecommerce platform)
5 = Mobile (Access with mobile identificator)
6 = Whatsapp (Access with whatsapp)
7 = Waitry (Waitry ecommerce platform)
8 = Vtex (Vtex ecommerce platform)
9 = Magento (Magento ecommerce platform)
10 = RCS (RCS platform)

string | null

Custom system code used.

string
required
length ≥ 1

Unique identifier of the customer in the originating system.

string | null

Customer code.

string
required

Customer mobile phone number.

boolean

Indicates whether the mobile phone has been validated.

string
required

Customer email address.

boolean

Indicates whether the email has been validated.

contact
object

Represents contact information associated with a customer.

address
object

Represents a postal address.

tags
object | null

Custom key-value tags associated to the customer.

string | null

Code of the store where the customer registered.

string | null

Code of the customer's preferred store.

string | null

Language code preference of the customer.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses
200

Identity created or updated successfully.

Updated 18 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 18 days ago

Did this page help you?