POST
/
v1
/
testing
/
shopper
/
create
Create Testing Shopper Account
curl --request POST \
  --url https://api.bolt.com/v1/testing/shopper/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "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"
}

Authorizations

​
X-API-Key
string
header
required

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

Headers

​
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].

Body

application/json
​
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
enum<string>

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".

Available options:
missing,
verified,
unverified
Example:

"verified"

​
phone
string

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

​
phone_state
enum<string>

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".

Available options:
missing,
verified,
unverified
Example:

"verified"

​
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

200 - application/json

Testing Account Created

​
email
string<email>

The email of the testing account

Maximum string length: 255
Example:

"alan.watts@example.com"

​
email_state
enum<string>

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".

Available options:
missing,
verified,
unverified
Example:

"verified"

​
phone
string

The phone number of the testing account

Maximum string length: 16
Example:

"+12125550199"

​
phone_state
enum<string>

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".

Available options:
missing,
verified,
unverified
Example:

"unverified"

​
otp_code
string

Fixed OTP code that can be used to login to the created account

Example:

123456

​
migrated_merchant_owner_id
string

The merchant's public id if the account is migrated

Example:

"addvfRR_bp_7"

​
will_deactivate_at
string

The created testing account will be deactivated after this date

Example:

"2023-06-01T23:16:07Z"

​
oauth_code
string

OAuth code that is associated with this account and can be used to exchange for an access token

Example:

"7GSjMRSHs6Ak7C_zvVW6P2IhZOHxMK7HZKW1fMX85ms.-DUXvwr1Yg-bfvqXUlMaz49fPn7OdiPa3TwVBlUI-wc"