MiB

Profiles

Guest and customer profiles for wishlist ownership.

Profiles represent a visitor or customer and own wishlist items. Use these endpoints to create or merge profiles. Authentication is required.

Create guest profile

POST /profile/guest

Request

{
  "sessionId": "guest-session-id",
  "email": "guest@example.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "device": "desktop",
  "locale": "en"
}

Response

{
  "profileId": "cuid...",
  "profileType": "guest",
  "shop": "example.myshopify.com"
}

Parameters

FieldTypeRequiredDescription
sessionIdstringyesAnonymous visitor id.
emailstringnoOptional email.
firstNamestringnoOptional name.
lastNamestringnoOptional name.
devicestringnoe.g. desktop, mobile.
localestringnoe.g. en, pl.

Merge guest into customer

POST /profile/merge

Request

{
  "customerId": "8769049329896",
  "sessionId": "guest-session-id",
  "email": "customer@example.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "device": "desktop",
  "locale": "en"
}

Response

{
  "profileId": "cuid...",
  "profileType": "account",
  "shop": "example.myshopify.com"
}

Parameters

FieldTypeRequiredDescription
customerIdstringyesNumeric Shopify customer id.
sessionIdstringnoGuest session id to merge.
emailstringnoCustomer email.
firstNamestringnoCustomer name.
lastNamestringnoCustomer name.
devicestringnoDevice label.
localestringnoLocale.

On this page