MerchantHQ API
POST /2024-09/marketplaces/catalog-item-imports
Default

Create a new import request for a marketplace catalog item.

application/json

Body Required

  • marketplace_id string(uuid) Required

    The UUID of the marketplace

  • marketplace_identifier string Required

    The marketplace-specific identifier to import

Responses

  • 201 application/json

    Import request created successfully

    Hide response attribute Show response attribute object
    • data object Required

      Representation of a catalog item import request

      Additional properties are NOT allowed.

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

        The UUID of the resource.

      • marketplace_id string(uuid)

        The UUID of the marketplace for this import

      • marketplace_identifier string

        The marketplace-specific identifier to import (e.g., ASIN on Amazon)

      • import_reason string

        The reason for the import

        Values are user_request or scheduled_update.

      • completed_at string | null

        When the import was completed

      • 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
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • message string
    • errors object
POST /2024-09/marketplaces/catalog-item-imports 
curl \
 --request POST 'https://app.merchanthq.com/api/2024-09/marketplaces/catalog-item-imports' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"marketplace_id":"1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4","marketplace_identifier":"B08N1W7D4R"}'
Request examples 
{
  "marketplace_id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
  "marketplace_identifier": "B08N1W7D4R"
}
Response examples (201) 
{
  "data": {
    "id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
    "marketplace_id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
    "marketplace_identifier": "B08N1W7D4R",
    "import_reason": "user_request",
    "completed_at": "2025-06-27T15:30:00Z",
    "created_at": "2025-01-10T10:37:11Z",
    "updated_at": "2025-01-10T10:37:11Z"
  }
}
Response examples (401) 
{
  "message": "Unauthorized"
}
Response examples (422) 
{
  "message": "The given data was invalid.",
  "errors": {
    "marketplace_id": [
      "The marketplace id field is required."
    ]
  }
}