Get Merchant
Retrieve merchant details based on a given merchant_id.
Merchant PII (name, email, etc.) is masked on this endpoint. If a merchant has forgotten what email they created their account under, you can view a masked version of their email on the Connection Health screen to help jog their memories. Ex. j*****e@example.com
Path Parameters
Query Parameters
Response
Retailer selling goods
The name of the merchants business
The Merchants unique email address
The Id of the User who owns this Merchant Account
The eCommerce platform this merchant uses
OTHER, SHOPIFY, MAGENTO, MAGENTO_ONE, WOOCOMMERCE, BIGCOMMERCE, LIGHTSPEED, ECWID, YAAS, SPREECOMMERCE, DEMANDWARE, VOLUSION, PRESTASHOP, THREEDCART, SYLIUS, WIX, SWELL, MIVA, WEBSPHERE, ORACLECC, SAPCC, SQUARESPACE, SHOPWARE, COMMERCETOOLS, MEDUSA, ABICART, SPRYKER, MYSTORE, CENTRA, XCART, VTEX, KIBO, SALEOR, VENDO, CHORD, DIGITALRIVER, SQUARE, AMAZON, BIGCARTEL, CUSTOM The eCommerce platform plan of the store
The URL of the Store
The custom URL of the Store
If a user has verified their email address. Deprecated (not used will always be false)
The status of the merchant
INACTIVE, ACTIVE, DISABLED, NEW, DISABLED_INACTIVE, FOR_DELETION, APPLICATION_IN_PROGRESS, APPLICATION_SUBMITTED, APPLICATION_DENIED, APPLICATION_ACCEPTED The default currency used by merchant
The default country of origin of merchant
The default state / province of origin of merchant
The default language used by merchant
The default commission rate of the merchant
Date of creation
Date of last update
ID of the Merchant on Ecommerce Platform
Determines if the merchants products are available to all apps or only available to apps of their choosing
PUBLIC, PRIVATE Default Unit of Weight in the Merchants Store
INCHES, FEET, CENTIMETERS, OUNCES, POUNDS, GRAMS, KILOGRAMS, CARATS, YARDS, MILLIMETERS, TONNES, MILLIGRAMS, LITERS, MILLILITERS, QUARTS, QUARTERS, GALLONS, PINTS, METERS Default Unit of Size in the Merchants Store
INCHES, FEET, CENTIMETERS, OUNCES, POUNDS, GRAMS, KILOGRAMS, CARATS, YARDS, MILLIMETERS, TONNES, MILLIGRAMS, LITERS, MILLILITERS, QUARTS, QUARTERS, GALLONS, PINTS, METERS Source of the merchant referral
VIOLET, PLATFORM_MARKETPLACE, AFFILIATE_PROGRAM, OTHER URL of the merchants logo
Merchant Category
OTHER, APPAREL_AND_ACCESSORIES, ANIMALS_AND_PET_SUPPLIES, ARTS_AND_ENTERTAINMENT, BABY_AND_TODDLER, BUSINESS_AND_INDUSTRIAL, CAMERAS_AND_OPTICS, ELECTRONICS, FOOD_BEVERAGE_TOBACCO, FURNITURE, HARDWARE, HEALTH_AND_BEAUTY, HOME_AND_GARDEN, LUGGAGE_AND_BAGS, MATURE, MEDIA, OFFICE_SUPPLIES, RELIGIOUS_AND_CEREMONIAL, SOFTWARE, SPORTING_GOODS, TOYS_AND_GAMES, VEHICLES_PARTS Featured Merchant. Deprecated (not used)
If a developers application has access to this merchant. Deprecated (not reliable) use connection health endpoint instead.
NOT_CONNECTED, CONNECTED, REQUESTED, DECLINED The shipping status of the merchant. Deprecated (not reliable)
The tax status of the merchant. Deprecated (not reliable)
Is this a Users default merchant
The billing status of the merchant. Deprecated (not reliable) use connection health endpoint instead.
Was this page helpful?