MerchantHQ API
POST /2024-09/suppliers
Default

Create a new supplier for a merchant

application/json

Body Required

  • merchant_id string(uuid) Required

    The UUID of the merchant that owns this supplier

  • name string Required

    The name of the supplier

  • default_currency string Required

    The default currency for this supplier's prices

    Format should match the following pattern: ^[A-Z]{3}$.

Responses

  • 201 application/json

    A successful response returning the created supplier

    Hide response attribute Show response attribute object
    • data object

      Representation of a supplier

      Additional properties are NOT allowed.

      Hide data attributes Show data attributes object
      • id string(uuid)

        The UUID of the resource.

      • merchant_id string(uuid)

        The UUID of the merchant that owns this supplier

      • name string

        The name of the supplier

      • default_currency string

        The default currency for this supplier's prices

        Format should match the following pattern: ^[A-Z]{3}$.

      • created_at string(date-time)

        The date and time the resource was created.

      • updated_at string(date-time)

        The date and time the resource was last updated.
  • 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/suppliers 
curl \
 --request POST 'https://app.merchanthq.com/api/2024-09/suppliers' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"merchant_id":"1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4","name":"Acme Supplies Co.","default_currency":"CAD"}'
Request examples 
{
  "merchant_id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
  "name": "Acme Supplies Co.",
  "default_currency": "CAD"
}
Response examples (201) 
{
  "data": {
    "id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
    "merchant_id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
    "name": "Acme Supplies Co.",
    "default_currency": "CAD",
    "created_at": "2025-01-10T10:37:11Z",
    "updated_at": "2025-01-10T10:37:11Z"
  }
}
Response examples (401) 
{
  "message": "Unauthorized"
}
Response examples (403) 
{
  "message": "This action is unauthorized."
}
Response examples (404) 
{
  "message": "Not found"
}