Skip to main content
POST
JavaScript

Authorizations

x-api-key
string
header
required

Body

application/json
merchantHost
string
required

The store, by the host Henry names it with (for example uniqlo.com). A URL is accepted and reduced to its host; a leading www. is ignored.

Minimum string length: 1
Example:

"uniqlo.com"

buyerEmail
string<email>
required

The buyer the login belongs to: the buyer.email your purchases at this store carry. Matched case-insensitively.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Example:

"jane@example.com"

username
string
required

What the buyer signs in to the store with, usually their email address.

Required string length: 1 - 320
Example:

"jane@example.com"

password
string
required

The buyer's password at the store. Stored encrypted and never returned by any endpoint.

Required string length: 1 - 1024
Example:

"correct-horse-battery-staple"

Response

Login connected

success
boolean
required
status
string
required
message
string
required
data
object
required