Skip to main content
GET
/
v1
/
system
/
merchants
List all Merchants
curl --request GET \
  --url https://{base_url_domain}/api/global/v1/system/merchants \
  --header 'Authorization: Bearer <token>'
{
  "collection": [
    {
      "type": "Merchant",
      "id": 4,
      "code": "acme_inc",
      "name": "ACME Inc.",
      "status": "active",
      "created_at": "2017-07-21T17:32:28Z",
      "updated_at": "2017-07-21T17:39:43Z",
      "brands": [
        {
          "type": "Brand",
          "id": 4
        }
      ],
      "default_brand": {
        "type": "Brand",
        "id": 4
      }
    }
  ],
  "included": {
    "Brand": [
      {
        "type": "Brand",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "is_active": true,
        "is_deleted": false,
        "sort_order": 0
      }
    ]
  },
  "has_more": true,
  "next": "<string>",
  "previous": "<string>",
  "meta": {
    "processing_time": 0.2525252525,
    "cursor_start": 123,
    "cursor_end": 123,
    "count": 123
  }
}

Authorizations

​
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Query Parameters

​
fields
enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

​
fields:brands
enum<string>[]

Specify additional fields of the Brand object to be included in the response. See the selecting fields page for more information.

​
fields:default_brand
enum<string>[]

Specify additional fields of the Brand object to be included in the response. See the selecting fields page for more information.

​
filter
string[]

The result is filtered to only include active merchants by default. To return only inactive merchants, set the inactive filter to true (e.g. ?filter=inactive:true). Otherwise, use any filter on status to override the default filter and potentially include inactive merchants in the results.

Using the filtering syntax, you may filter the results using the following fields:

  • id
  • code
  • name
  • status
  • created_at
  • updated_at
  • inactive (boolean)
Example:
["name{regex:\"^ACME\"}"]
​
sort
string

The default sort order is ascending by primary key (sort=id). Use the sorting syntax to override the default sort order. The following fields are available for sorting:

  • id
  • code
  • name
  • status
  • created_at
  • updated_at
Example:

"created_at,-id"

​
count
integer

If specified as 1, the meta.count property of the response will be present and populated with the total count of items matching the query before any paging is applied. This is not included by default to improve performance in some edge cases and is not required to perform paging using the next property of the response. See paging parameters for more information.

Required range: 0 <= x <= 1
​
cursor_end
integer

A cursor for use in pagination which defines the last id of the next page of results, non-inclusive. See paging parameters for more information on paging.

​
cursor_start
integer

A cursor for use in pagination which defines the starting id of the next page of results. See paging parameters for more information on paging.

​
limit
integer
default:100

A limit on the number of objects to be returned.

Required range: 1 <= x <= 1000
Example:

100

Response

A dictionary with a collection property that contains an array of up to limit Merchant objects. If no merchants are found the array will be empty.

​
collection
Merchant · object[]

A list of Merchant objects.

​
included
object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.

​
has_more
boolean

True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.

​
next
string | null

The resource path for the next page of results if any are expected.

​
previous
string | null

The resource path for the previous page of results if any are expected.

​
meta
object

Additional metadata pertaining to the response.