List of marketplace catalog item imports

GET /2024-09/marketplaces/catalog-item-imports

Default

Get the list of catalog item import requests with optional filters.

Query parameters

marketplace_id string(uuid)

Filter imports by marketplace UUID
import_reason string

Filter by import reason

Values are user_request or scheduled_update.
completed boolean

Filter by completion status
page integer

The page number to retrieve

Minimum value is 1.
per_page integer

The number of results to return per page

Minimum value is 1, maximum value is 100.

Responses

200 application/json

A successful response returning the list of marketplace catalog item imports
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
  
  Representation of a catalog item import request
  
  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

GET /2024-09/marketplaces/catalog-item-imports

curl \
 --request GET 'https://app.merchanthq.com/api/2024-09/marketplaces/catalog-item-imports' \
 --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": "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."
    ]
  }
}