List of channels

GET /2024-09/channels

Default

Get the list of channels for the specified merchant.

Query parameters

q string

A search query to filter the channels by name.
type string

Filter channels by type.

Value is amazon.
merchant_id string(uuid) Required

The UUID of the merchant

Responses

200 application/json

A successful response returning the list of channels.
Hide response attributes Show response attributes object
- links object
  
  Hide links attributes Show links attributes object
  
  first string
  
  last string
  
  prev string | null
  
  next string | null
- meta object
  
  Hide meta attributes Show meta attributes object
  
  current_page integer
  
  from integer | null
  
  last_page integer
  
  path string
  
  per_page integer
  
  to integer | null
  
  total integer
- data array[object] Required
  
  Hide data attributes Show data attributes object
  
  id string(uuid) Required
  
  merchant_id string(uuid) Required
  
  name string Required
  
  type string Required
  
  Value is amazon.
  
  created_at string(date-time) Required
  
  updated_at string(date-time) Required
401 application/json

The request requires user authentication or the user is not authorized to access this resource.
Hide response attribute Show response attribute object
- message string
403 application/json

Forbidden - The user does not have permission to access this resource.
Hide response attribute Show response attribute object
- message string Required
404 application/json

The specified resource was not found
Hide response attribute Show response attribute object
- message string

GET /2024-09/channels

curl \
 --request GET 'https://app.merchanthq.com/api/2024-09/channels?merchant_id=1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "links": {
    "first": "https://app.merchanthq.com/api/2024-09/merchants?page=1",
    "last": "https://app.merchanthq.com/api/2024-09/merchants?page=10",
    "prev": "https://app.merchanthq.com/api/2024-09/merchants?page=1",
    "next": "https://app.merchanthq.com/api/2024-09/merchants?page=3"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "path": "https://app.merchanthq.com/api/2024-09/merchants",
    "per_page": 10,
    "to": 10,
    "total": 20
  },
  "data": [
    {
      "id": "string",
      "merchant_id": "string",
      "name": "string",
      "type": "amazon",
      "created_at": "2025-05-04T09:42:00Z",
      "updated_at": "2025-05-04T09:42:00Z"
    }
  ]
}

Response examples (401)

{
  "message": "Unauthorized"
}

Response examples (403)

{
  "message": "This action is unauthorized."
}

Response examples (404)

{
  "message": "Not found"
}