MerchantHQ API
GET /2024-09/channels/{channel}
Default

Fetches detailed information about the specified channel

Path parameters

  • channel string Required

    The UUID of the channel.

Responses

  • 200 application/json

    A successful response returning the channel's details.

    Hide response attribute Show response attribute object
    • data object
      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/{channel} 
curl \
 --request GET 'https://app.merchanthq.com/api/2024-09/channels/1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "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"
}