Sign in

v2

latestOpenAPI 3.0.02026-07-3139594346.4 KB
Testing

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.

post/v1/testing/shopper/create

Headers

X-Publishable-Keystring

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

deactivate_in_daysinteger

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

emailstring

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

email_state'missing' | 'verified' | 'unverified'

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

phonestring

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

phone_state'missing' | 'verified' | 'unverified'

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

migratedboolean

Set this account as migrated by the merchant in the request

has_addressboolean

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

Example request

{
  "deactivate_in_days": 30,
  "email_state": "verified",
  "phone_state": "verified"
}

Response

Testing Account Created

emailstring email

An email address.

email_state'missing' | 'verified' | 'unverified'

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

phonestring

A phone number following E164 standards, in its globalized format, i.e. prepended with a plus sign.

phone_state'missing' | 'verified' | 'unverified'

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

otp_codestring

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

migrated_merchant_owner_idstring

The merchant's public id if the account is migrated

will_deactivate_atstring

The created testing account will be deactivated after this date

oauth_codestring

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

Example response

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