SIsilverflow
Merchants

List Merchants

This operation returns a (paged) list of all Merchants for the authenticated Agent.

Requires merchants:List permission.

get/merchants

Request

Query parameters

sortOrder'asc' | 'desc'

The sort order, __asc__ending or __desc__ending

limitinteger

The number of items to return

offsetTokenstring

The offset token. This token is returned in the response of previous request.

merchantReferencestring

Merchant reference number used by the Agent. Must not start with "mct-".

Response

A (paged) list of Merchants

offsetTokenstring
moreItemsboolean

Example response

{
  "merchants": [
    {
      "key": "mct-1hPdFhmgaBzMS191nIbJ",
      "status": "active",
      "agentKey": "cgt-1hPdFhmgaBzMS85d4QcG",
      "merchantReference": "AB1234-5678_10.31",
      "name": "ACME Corporation A/S",
      "description": "ACME Corporation. Building materials, rockets and birdseed.",
      "legalName": "ACME Corp. A/S",
      "registeredAddress": {
        "countryCode": {
          "alpha3": "USA",
          "alpha2": "US",
          "numeric": 528
        },
        "stateOrProvince": "CA",
        "city": "Hill Valley",
        "line1": "Riverside Drive 1640",
        "postalCode": "91103"
      },
      "customerInquiry": "+15554321",
      "websiteUrl": "https://acme.com/catalog/acme.html",
      "created": "2021-05-27T10:57:52Z",
      "lastModified": "2021-05-27T10:57:52Z",
      "version": 1,
      "sellerEmail": "seller@gmail.com",
      "taxRegistrationId": "US1234567890",
      "businessType": "corporation"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.