Skip to main content
GET
/
merchants
/
{merchantDomain}
/
status
JavaScript
import HenrySDK from '@henrylabs/sdk';

const client = new HenrySDK({
  apiKey: process.env['HENRY_SDK_API_KEY'], // This is the default and can be omitted
});

const response = await client.merchants.checkStatus('walmart.com');

console.log(response.message);
{
  "success": true,
  "status": "<string>",
  "message": "<string>",
  "data": {
    "merchantSupportStatus": true
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
merchantDomain
string
required

Merchant Domain

Minimum string length: 1
Example:

"walmart.com"

Query Parameters

​
checkoutMode
enum<string>
default:allowlist

Checkout mode to check merchant support against. 'allowlist' only allows explicitly approved merchants, 'blocklist' allows all except explicitly blocked merchants.

Available options:
allowlist,
blocklist
Example:

"allowlist"

Response

Merchant support status retrieved successfully

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