Skip to main content
GET /merchants/{merchantId} returns the full profile of a single merchant sub-account linked to your company. You can identify the merchant using any of three values — businessAccountCode, externalMerchantId, or MongoDB _id — whichever is most convenient for your system.

Requirements

  • Account type: Company account only.
  • Scope: merchants

Authentication

Path parameter

string
required
The merchant identifier. Accepts any of the following:The API resolves all three formats automatically — you do not need to specify which type you are sending.

Request

Fetch by externalMerchantId

Fetch by businessAccountCode

Response

200 — Success

string
MongoDB _id of the merchant account.
string
8-digit code assigned by Now Shipping. Use this as X-Merchant-Id on order and pickup requests.
string
Merchant owner or business name.
string
Public-facing brand name.
string
Contact email address.
string
Contact phone number.
string
Your platform’s shop ID, as provided at onboarding.
boolean
true when the merchant profile is fully complete.
boolean
true when the account is verified and ready to create shipments.
string
MongoDB _id of the company account that owns this merchant sub-account.
string
ISO 8601 timestamp of when the account was created.

Errors

A 404 means either the ID doesn’t exist or the merchant belongs to a different company. Use GET /merchants with a search query to browse your linked accounts, or call POST /merchants to onboard the merchant if they haven’t been created yet.