GET
/
v1
/
system
/
merchants
List all Merchants
curl --request GET \
  --url https://{client_id}.shipstream.app/api/global/v1/system/merchants
{
  "collection": [
    {
      "type": "Merchant",
      "id": 4,
      "code": "acme_inc",
      "name": "ACME Inc.",
      "is_active": true,
      "is_deleted": false,
      "sort_order": 5,
      "created_at": "2017-07-21T17:32:28Z",
      "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
  }
}

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[]

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

id code name is_active sort_order is_default created_at is_deleted

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
  • is_active
  • sort_order
  • created_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

200
application/json

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.

The response is of type object.