Developer Console
Sign In
Sign In
Developer Console

Get Catalog Upload Status

As your company uses HAQM’s retail technology, you will need to provide HAQM with a catalog of detailed product information for the products you sell and keep this information up-to-date. You can update your catalog manually using the 3PCC Portal or you can use our Catalog API, which allows you to programmatically update your catalog through a simple REST API. This spec will assist you in automating your catalog updates using the HAQM Catalog API.

Note: In the future, new attributes might be added. We recommend that you structure your code so that it can handle new attributes gracefully

Operations

Get Catalog Upload Status

POST /v1/catalog/getCatalogUploadStatus

The GetCatalogUploadStatus API method allows you to get the status of your catalog upload.

Body parameter

{
  "ingestionId": "string"
}
Data Field Required Description
ingestionId Required <= 255 characters. Unique ID for a catalog upload to HAQM systems. HAQM will generate a unique id for each catalog upload

Example responses

200 Response

{
  "processingStatus": "string",
  "reportDownloadLink": "string"
}
Data Field Required Description
processingStatus Required string. Catalog upload status: DONE, INQUEUE, INPROGRESS, CANCELLED and FATAL
reportDownloadLink Required string. Catalog processing report download link

Error Response

{
  "errorMsg": "<ERROR_MESSAGE_HERE>"
}

Example responses

Status Meaning Description
200 OK processingStatus: Catalog upload status: DONE, INQUEUE, INPROGRESS, CANCELLED and FATAL, reportDownloadLink: Catalog processing report download link
400 InvalidRequestException You will receive a 400 when the API was invoked with invalid ingestionId parameter or ingestionId not associated with any of the retailers
400 BadRequestException You will receive a 400 when the API was invoked with invalid request model parameters
429 Too Many Requests You will receive with a 429 error message when the API is called too many times. When you receive a 429 error due to multiple calls to the API you will receive the following response. errorMsg: Too Many Requests
500 Internal Server Error You will receive with a 500 error message when the API call fails due to an error.

Response payload examples

Status code Message Meaning
200 
{
    "processingStatus": "DONE",
    "reportDownloadLink": ""
}
Catalog Upload is DONE
200 
{
  "processingStatus": [
    "INQUEUE",
    "INPROGRESS"
  ],
  "reportDownloadLink": ""
}
Catalog Upload is still in progress
200 
{
  "processingStatus": [
    "CANCELLED",
    "FATAL"
  ],
  "reportDownloadLink": ""
}
Catalog Upload failed
400 
{
    "errorMsg": "API invoked with Invalid parameter"
}
If API is invoked with invalid ingestionId parameter
400 
{
    "errorMsg": "API invoked with Invalid parameter"
}
If API is invoked with ingestionId not associated with any of the retailers
400 
{
    "message": "Invalid request body"
}
If API is invoked with invalid request model parameters
500 
{
    "errorMsg": "Exception encountered while processing the request"
}
Internal server error
429 
{
    "message": "Too Many Requests"
}
Throttling