MerchantHQ API
POST /2024-09/channels
Default

Create a new channel for the specified merchant.

application/json

Body Required

  • merchant_id string(uuid) Required

    The UUID of the resource.

  • name string Required
  • type string Required

    Value is amazon.

Responses

  • 201 application/json

    A successful response returning the created channel.

    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
POST /2024-09/channels 
curl \
 --request POST 'https://app.merchanthq.com/api/2024-09/channels' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"merchant_id":"1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4","name":"string","type":"amazon"}'
Request examples 
{
  "merchant_id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
  "name": "string",
  "type": "amazon"
}
Response examples (201) 
{
  "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"
}