Merchant API
List Alerts
Returns all outstanding alerts for this merchant.
Filters
All filters should be passed in the URL as GET arguments.
| Argument | Description |
|---|---|
| include_dismissed | Y or N. Default N. If Y, Alerts that are no longer active will also be returned |
Array Response Fields
| Field | Data Type | Length | Description |
|---|---|---|---|
| notification_pk | Int | Unique identifier for this alert | |
| first_datetime | Timestamp | Time error first occurred | |
| last_datetime | Timestamp | Time error most recently occurred or was resolved | |
| subject | String | Alert subject line / Summary | |
| message | String | Alert message details. May contain newline characters "\n" | |
| error_type | String | Which process failed. Eg: INVENTORYUPLOAD, ORDERDOWNLOAD, WMSORDERSEND, SHIPCONF | |
| error_id | String | Specific record that failed. Could be an order number or a product sku | |
| duplicates | Int | Count of number of times this exact error occurrend | |
| order_source | String | Order Source name of affected cart. Blank if this not a cart level error. | |
| dismissed_sw | Boolean | true if alert has already been dismissed | |
| resolved_automatically | Boolean | true if system auto-resolved this alert. For this to be true, dismissed_sw must also be true |
get/v1/merchant/alerts
Request
- Base URLhttp://{{base_url}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
OK
object required
Changes
No recorded changes to this operation across all 1 revision of this API.