Incidents
Problems reported during picking or packing, or manually in Chameleoon, such as a missing or damaged item or a label that could not be created. Requires the incidents read permission.
Each incident has a problem type and a severity. A critical incident linked to a fulfillment blocks it until the incident is resolved. List the incidents of an order with GET /v2/incidents?orderIds={orderId}.
List incidents
Returns a paginated list of incidents, newest first. Details such as products and activity are not included; use GET /v2/incidents/{id}.
Without a date range, incidents from the last 60 days are returned. A date range can span up to one year. When orderIds is set, the date range is ignored.
query Parameters
pagePage number for pagination
pageSizeNumber of items per page
orderIdsOrder IDs, up to 20. Repeat the parameter for multiple values. The date range is ignored.
createdFromIncidents reported from this date and time, inclusive (format yyyy-MM-ddTHH:mm:ss.fff). Defaults to 60 days before createdTo, or before today. Ignored when orderIds is set.
createdToIncidents reported up to this date and time, inclusive (format yyyy-MM-ddTHH:mm:ss.fff). The range can span up to one year.
statusIncident statuses. Repeat the parameter for multiple values.
severityIncident severities. Repeat the parameter for multiple values.
blockingtrue returns only incidents that currently block a fulfillment, false returns the rest. Omit to return both.
Headers
Accept-LanguageLanguage code for localized responses
List incidents › Responses
Paginated list of incidents
pageCurrent page number
pageSizeNumber of items per page
totalPagesTotal number of pages
nextPageWhether a next page exists
previousPageWhether a previous page exists
itemsCountTotal number of items across all pages
Incidents, newest first. Details such as products and activity are not included; use GET /v2/incidents/{id}.
Get incident by ID
Returns an incident with its products, error details and activity.
path Parameters
idUnique incident identifier
Headers
Accept-LanguageLanguage code for localized responses
Get incident by ID › Responses
The incident with its products, errors and activity
idUnique incident identifier
numberIncident number
Problem type, as set up in your incident settings
stageWarehouse stage the problem relates to
kindKind of problem.
product— an issue with goods, such as a missing or damaged item; seeaffectedProductsoperation— a process failure, such as a label that could not be created; seeoperationError
severitySeverity of an incident.
info— informationalwarning— needs attentioncritical— blocks the related fulfillment, if there is one, until resolved
statusStatus of an incident.
open— reported, not taken yetin_progress— taken by a team memberresolved— resolved
blockingWhether the incident is currently blocking its fulfillment
sourceWhere the incident was reported.
mobile_app— in the Chameleoon mobile appclient_app— in the Chameleoon web app
assignedWhether a team member has taken the incident
affectedProductCountNumber of entries in affectedProducts
missingQuantityTotal quantity reported missing, including products already resolved
commentCountNumber of comments
createdAtWhen the incident was reported (format yyyy-MM-ddTHH:mm:ss.fff)
statusChangedAtWhen the status or assignment last changed (format yyyy-MM-ddTHH:mm:ss.fff)
Affected products; can be empty
Incident history, oldest first
orderIdRelated order; null if none
fulfillmentIdRelated fulfillment; null if none
pickingIdPicking during which the incident was reported; null if reported outside a picking
referenceNumberOrder number
dispositionAction the problem type sets for the fulfillment when the incident is critical; null if none.
held— after picking, the fulfillment returns topendingparked— after picking, the picked items are set aside and the fulfillment moves topicking_stagedleft_packing— packing stops and the fulfillment returns topicked
snoozedUntilSnoozed until this time; null if not snoozed. A past value means the snooze has ended (format yyyy-MM-ddTHH:mm:ss.fff)
resolvedAtWhen the incident was resolved; null until then (format yyyy-MM-ddTHH:mm:ss.fff)
descriptionNote from the person who reported the incident
Error details of an operation incident; null for product incidents or when no details were recorded
resolutionMessageResolution note; null until resolved