Create Testing Shopper Account

Create a Bolt shopper account for testing purposes. Available for sandbox use only and the created account will be recycled after a certain time.

Authorization

X-API-Key

X-API-Key<token>

Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.

In: header

Header Parameters

X-Publishable-Key?string

The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

deactivate_in_days?integer

Number of days after which the test account is deactivated. Default: 30 days. Maximum: 180 days.

email?string

Deprecated. Please leave this field absent and let the API automatically generate a random email.

email_state?account_identifier_status

The status of the shopper account identifier (email or phone). If the account does not have this identifier, the status is "missing"; If the identifier has been used to receive an OTP code, the status is "verified"; If the identifier has not been used to receive an OTP code, the status is "unverified".

Value in

"missing"
"verified"
"unverified"

phone?string

Deprecated. Please leave this field absent and let the API automatically generate a random phone number.

phone_state?account_identifier_status

Value in

"missing"
"verified"
"unverified"

migrated?boolean

Set this account as migrated by the merchant in the request

has_address?boolean

Add a random U.S. address to the created account if set to true

Response Body

`application/json`

curl -X POST "https://example.com/v1/testing/shopper/create" \  -H "Content-Type: application/json" \  -d '{    "deactivate_in_days": 30,    "email_state": "verified",    "phone_state": "verified"  }'

{  "email": "alan.watts@example.com",  "email_state": "verified",  "phone": "+12125550199",  "phone_state": "unverified",  "otp_code": 123456,  "migrated_merchant_owner_id": "addvfRR_bp_7",  "will_deactivate_at": "2023-06-01T23:16:07Z",  "oauth_code": "7GSjMRSHs6Ak7C_zvVW6P2IhZOHxMK7HZKW1fMX85ms.-DUXvwr1Yg-bfvqXUlMaz49fPn7OdiPa3TwVBlUI-wc"}