List Sales Channels

Retrieve a list of sales channels. The sales channels can be filtered by fields such as q or name. The sales channels can also be sorted or paginated.

Request

Query Params

string

optional

Filter by a sales channel ID.

name

string

optional

Filter by name.

description

string

optional

Filter by description.

string

optional

term used to search sales channels' names and descriptions.

order

string

optional

A sales-channel field to sort-order the retrieved sales channels by.

array[string]

optional

filter by dates less than this date

Example:

["","",""]

array[string]

optional

filter by dates greater than this date

Example:

["","",""]

lte

array[string]

optional

filter by dates less than or equal to this date

Example:

["","",""]

gte

array[string]

optional

filter by dates greater than or equal to this date

Example:

["","",""]

offset

integer

optional

The number of sales channels to skip when retrieving the sales channels.

limit

integer

optional

Limit the number of sales channels returned.

expand

string

optional

Comma-separated relations that should be expanded in the returned sales channels.

fields

string

optional

Comma-separated fields that should be included in the returned sales channels.

Responses

🟢200OK

application/json

Body

count

integer

required

The total number of items available

offset

integer

required

The number of items skipped before the returned results

limit

integer

required

The number of items per page

sales_channels

array[object (Sales Channel) {9}]

required

An array of sales channels details.

string

required

The sales channel's ID

Example:

sc_01G8X9A7ESKAJXG2H0E6F1MW7A

name

string

required

The name of the sales channel.

Example:

Market

description

string | null

required

The description of the sales channel.

Example:

Multi-vendor market

is_disabled

boolean

required

Specify if the sales channel is enabled or disabled.

Default:

false

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

metadata

object | null

optional

An optional key-value map with additional details

Example:

{"car":"white"}

locations

array[object (Sales Channel Stock Location) {7}]

optional

The details of the stock locations related to the sales channel.

Example

{
  "count": 0,
  "offset": 0,
  "limit": 0,
  "sales_channels": [
    {
      "id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
      "name": "Market",
      "description": "Multi-vendor market",
      "is_disabled": false,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "metadata": {
        "car": "white"
      },
      "locations": [
        {
          "id": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A",
          "sales_channel_id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
          "location_id": "string",
          "sales_channel": {},
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "deleted_at": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ]
}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

List Sales Channels

Request

Request samples

Responses