Skip to main content
POST
/
auth
/
anonymous
Create anonymous session
curl --request POST \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/auth/anonymous \
  --header 'X-Api-Key: <api-key>'
{
  "message": "<string>",
  "success": true,
  "content": {
    "user": {
      "id": "<string>",
      "is_anonymous": true,
      "is_logged_in": true,
      "first_name": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "is_email_verified": false,
      "is_phone_verified": false,
      "profile_image_url": "<string>",
      "created_at": "<string>",
      "modified_at": "<string>"
    },
    "access_token": "<string>",
    "refresh_token": "<string>"
  }
}

Authorizations

​
X-Api-Key
string
header
required

API key for your store

Response

OK

​
message
string
required

A string containing a descriptive message related to the success or failure of the anonymous user creation or authentication.

​
success
boolean
required

A boolean value indicates the success or failure of the anonymous user operation.true for success false for failure.

​
content
object
required

An object containing the response content.