ItemMaster®

API Documentation
Home

Items Status: Response XML fields description


Input Container/Field

Type

Occurrence

Meaning

feedId String Required

 a correlation id to partners so that they can query the status and response later for the feed. 

feedStatus String Required

 INPROGRESS / RECEIVED / PROCESSED /ERROR overall status of the request. Item statuses are in items detail.

  • RECEIVED - This status means that the feed has been received by the ItemMaster gateway but the (asynchronous) processing has not yet started.
  • INPROGRESS - This status means that element processing in the feed has begun and is not yet completed.
  • PROCESSED - This status means that element processing in the feed is complete. Nothing is implied about the status of the individual elements.
  • ERROR - This means that the feed, as a whole, has failed. No elements within the feed were processed.
itemsReceived Number Required how many components were found in the feed
itemsSucceeded Number Required how many items succeeded
itemsFailed Number Required

how many items ended in error, due to data error or system error, exact error type will be indicated by error code for the item

itemsProcessing  Number Required how many items are still being processed?
offset Number Required  index of the first item status being reported in this response, 0 based offset, used for response pagination of large feeds
limit Number Required number of items being reported in this response,used for response pagination of large feeds
itemDetails  Collection Required Indicates detailed response for the feed
ProductCode String Required Product Code to uniquely identify the item
index Number Required position of the item in the feed
ingestionStatus String Required

DATA_ERROR / SYSTEM_ERROR / TIMEOUT_ERROR / INPROGRESS / PROCESSED / REJECTED SUCCESS

  • DATA_ERROR - This error means that there is either a malformed XML error, or there is some system data that is missing. If the XML passes validation against the relevant XSD, and the error persists, please contact ItemMaster.
  • SYSTEM_ERROR - This error is returned when a downstream ItemMaster system returns an error to an attempted operation during ingestion. If this error occurs, please wait a suitable time (at least an hour) and try again. If the error persists, please contact ItemMaster.
  • TIMEOUT_ERROR - This error is returned when a downstream ItemMaster system is not available during ingestion. If this error occurs, please wait a suitable time (at least an hour) and try again. If the error persists, please contact ItemMaster.
  • INPROGRESS - This means that the item ingestion has not completed.
  • PROCESSED - Indicates that the item has been ingested successfully.
  • REJECTED - Indicates that the item has rejected by ItemMaster quality analyst. Please contact ItemMaster.
  • SUCCESS - Indicates that the item has successfully processed by ItemMaster.
ingestionRemarks String Optional Contains the cause for item rejection.
ingestionErrors String Optional Contains information about errors in item data.