Notifications


Within Quipt users may subscribe to a defined set of events that occur throughout the application. When an event is fired a notification is sent to the user. The following API endpoints allow the user to access the notifications generated. Currently the endpoints only allows the user to monitor for new messages and archive those that are no longer needed.

Sample use cases.

  • Tracking movement through any work flow, ie Orders.
  • Monitor for changes, including price and quantity.

Get Notifications

This endpoint allows the user to monitor messages sent to their account. Each of the specified types can be used to determine what additional API call can be utilized to get more details for a specific notification.

URLhttps://api.getquipt.com/v2/notifications/{pageSize}/{pageNumber}
 
Methodget

Parameters:

Name Description Type Required
{pageSize} The maximum number of records to return. The maximum value is 200. Int Yes
{pageNumber} The page to retrieve. String Yes
&statuses A comma separated list of statuses to include in the result set. Available statuses are 1 = Unread, 2 = Read, and 4 = Archived. Int No
&types A comma separated list of types to include in the result set. Available types include Batch, Blog, Report, PurchaseOrder, SalesOrder, VirtualInventory, PhysicalInventory, Feeds, ChannelRequest, and VendorRequest. String No

Sample Header:

Sample Response (JSON):

Response Definitions:

Name Description Type
Paging Paging information for the records returned. Paging
Result The collection of notifications. NotificationResult[]
TransactionId The transaction id for the request. String
TransactionTime The time the transaction took place. DateTime
Success Whether or not the transaction was successful Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]

The API provides a mechanism to get more details of each referenced Type. Using the table below locate the referenced Type and replace {id} with the RecordId to get the details.

Type Endpoint
Batch Batch is used with multiple sub-systems. Use the following table to direct you to the correct URL.
Blog No service available currently.
Report No service available currently.
PurchaseOrder https://api.getquipt.com/v2/orders/purchase/id/{id}
SalesOrder https://api.getquipt.com/v2/orders/fulfillment/id/{id}
VirtualInventory https://api.getquipt.com/v2/inventory/virtual/id/{id}
PhysicalInventory https://api.getquipt.com/v2/inventory/physical/id/{id}
Feeds No service available currently.
ChannelRequest https://api.getquipt.com/v2/requests/purchase/id/{id}
VendorRequest https://api.getquipt.com/v2/requests/fulfillment/id/{id}

Below is a list of currently available events for capture.

Type Event Code Event Name
Batch 10 Status Changed
Batch 11 Completed
Batch 12 Failed
Report 110 Created
Report 111 Status Change
Report 112 Removed
Report 113 Shared
Report 114 Report Queued
Report 115 Queued Report Status Change
Report 116 Report Generated
Report 117 Report Downloaded
Blog 170 Created
Blog 171 General Message Created
Blog 172 Application Update Message Created
Blog 173 Scheduled Downtime Message Created
Blog 174 Unscheduled Downtime Message Created
PhysicalInventory 22 Cost Change
PhysicalInventory 23 Discontinued
PhysicalInventory 24 Published
PhysicalInventory 25 Out Of Stock
PhysicalInventory 26 Add Stock
PhysicalInventory 27 Quantity Change
PhysicalInventory 28 Quantity Allocated Change
PhysicalInventory 29 Outsourced
PhysicalInventory 30 Status Change
VirtualInventory 40 Activation Change
VirtualInventory 41 Allocation Change
VirtualInventory 42 Promotion Initialized
VirtualInventory 43 Promotion Removed
VirtualInventory 44 Price Change
VirtualInventory 45 Catalog Status Change
VirtualInventory 46 Inventory Status Change
VirtualInventory 47 ARP Change
VirtualInventory 48 Promotion Change
VirtualInventory 25 Out Of Stock -NEED IMPL
VirtualInventory 26 Add Stock -NEED IMPL
VirtualInventory 27 Quantity Change -NEED IMPL
VirtualInventory 24 Published -NEED IMPL
Feeds 40 Activation Change
Feeds 41 Allocation Change
Feeds 42 Promotion Initialized
Feeds 43 Promotion Removed
Feeds 44 Price Change
Feeds 45 Catalog Status Change
Feeds 46 Inventory Status Change
Feeds 47 ARP Change
Feeds 48 Promo Change
PurchaseOrder 50 Status Change
PurchaseOrder 51 Placed
PurchaseOrder 52 Canceled
PurchaseOrder 53 Price Change
PurchaseOrder 54 Quantity Ordered Change
PurchaseOrder 55 Quantity Back Ordered
PurchaseOrder 56 Quantity Canceled
PurchaseOrder 57 Ship To Change
PurchaseOrder 58 Shipped
PurchaseOrder 59 Action Required
PurchaseOrder 330 Action Required – Invalid SKU
PurchaseOrder 331 Action Required – Duplicate Order Detected
PurchaseOrder 332 Action Required – Out of Stock
PurchaseOrder 333 Action Required – Invalid Pricing
PurchaseOrder 334 Action Required – Invalid Ship-To Address
PurchaseOrder 335 Action Required – Invalid Carrier Method Selected
PurchaseOrder 336 Action Required – Execution of Custom Code Failed
PurchaseOrder 337 Action Required – Invalid Payment
PurchaseOrder 338 Action Required – On Hold
PurchaseOrder 339 Action Required – Late Back Order
PurchaseOrder 340 Action Required – Late Shipment
PurchaseOrder 341 Action Required – Late Shipment Pickup
PurchaseOrder 342 Action Required – Warehouse Cancellation
PurchaseOrder 343 Action Required – Shipment Exception
PurchaseOrder 344 Action Required – Payment Capture Failed
PurchaseOrder 345 Action Required – Payment Refund Failed
PurchaseOrder 346 Action Required – Invalid Tracking Number
PurchaseOrder 347 Action Required – Cancellation Requested
SalesOrder 50 Status Change
SalesOrder 51 Placed
SalesOrder 52 Canceled
SalesOrder 53 Price Change
SalesOrder 54 Quantity Ordered Change
Salesrder 55 Quantity BackOrdered
SalesOrder 56 Quantity Canceled
SalesOrder 57 Ship To Change
SalesOrder 58 Shipped
SalesOrder 59 Action Required
SalesOrder 330 Action Required – Invalid SKU
SalesOrder 331 Action Required – Duplicate Order Detected
SalesOrder 332 Action Required – Out of Stock
SalesOrder 333 Action Required – Invalid Pricing
SalesOrder 334 Action Required – Invalid Ship-To Address
SalesOrder 335 Action Required – Invalid Carrier Method Selected
SalesOrder 336 Action Required – Execution of Custom Code Failed
SalesOrder 337 Action Required – Invalid Payment
SalesOrder 338 Action Required – On Hold
SalesOrder 339 Action Required – Late Back Order
SalesOrder 340 Action Required – Late Shipment
SalesOrder 341 Action Required – Late Shipment Pickup
SalesOrder 342 Action Required – Warehouse Cancellation
SalesOrder 343 Action Required – Shipment Exception
SalesOrder 344 Action Required – Payment Capture Failed
SalesOrder 345 Action Required – Payment Refund Failed
SalesOrder 346 Action Required – Invalid Tracking Number
SalesOrder 347 Action Required – Cancellation Requested
ChannelRequest 91 Tracking Change
ChannelRequest 92 Action Status Change
ChannelRequest 94 Comment Change
ChannelRequest 90 Created
ChannelRequest 95 Closed
ChannelRequest 96 Canceled
ChannelRequest 97 Action Required
ChannelRequest 93 Status Change
ChannelRequest 200 Intercept Attempt
ChannelRequest 201 Intercept Failed
ChannelRequest 202 Intercept In-Route
ChannelRequest 203 Intercept Delivered
ChannelRequest 210 Lost Shipment Trace Requested
ChannelRequest 211 Lost Shipment Trace Failed
ChannelRequest 212 Lost Shipment In-Route
ChannelRequest 213 Lost Shipment Delivered
ChannelRequest 214 Lost Shipment Claim Opened
ChannelRequest 215 Lost Shipment Claim Paid
ChannelRequest 216 Lost Shipment Claim Denied
ChannelRequest 220 Missing Accessory Credit Offered
ChannelRequest 221 Missing Accessory Credit Countered
ChannelRequest 222 Missing Accessory Return Created
ChannelRequest 223 Missing Accessory Label Requested
ChannelRequest 225 Missing Accessory Label Generated
ChannelRequest 226 Missing Accessory Label Generation Error
ChannelRequest 227 Missing Accessory Credit Accepted
ChannelRequest 228 Missing Accessory Pickup Requested
ChannelRequest 229 Missing Accessory Shipped
ChannelRequest 240 Partial Credit Accepted
ChannelRequest 241 Partial Credit Counter
ChannelRequest 242 Partial Credit Impasse
ChannelRequest 250 Return Credited
ChannelRequest 251 Return Credit Offered
ChannelRequest 252 Return Exchanged
ChannelRequest 253 Return Received
ChannelRequest 254 Return Label Requested
ChannelRequest 256 Return Label Generated
ChannelRequest 257 Return Label Generation Error
ChannelRequest 258 Return Pickup Requested
ChannelRequest 259 Return Accepted
ChannelRequest 260 Warranty Check Failed
VendorRequest 91 Tracking Change
VendorRequest 92 Action Status Change
VendorRequest 94 Comment Change
VendorRequest 90 Created
VendorRequest 95 Closed
VendorRequest 96 Canceled
VendorRequest 97 Action Required
VendorRequest 93 Status Change
VendorRequest 200 Intercept Attempt
VendorRequest 201 Intercept Failed
VendorRequest 202 Intercept In-Route
VendorRequest 203 Intercept Delivered
VendorRequest 210 Lost Shipment Trace Requested
VendorRequest 211 Lost Shipment Trace Failed
VendorRequest 212 Lost Shipment In-Route
VendorRequest 213 Lost Shipment Delivered
VendorRequest 214 Lost Shipment Claim Opened
VendorRequest 215 Lost Shipment Claim Paid
VendorRequest 216 Lost Shipment Claim Denied
VendorRequest 220 Missing Accessory Credit Offered
VendorRequest 221 Missing Accessory Credit Countered
VendorRequest 222 Missing Accessory Return Created
VendorRequest 223 Missing Accessory Label Requested
VendorRequest 225 Missing Accessory Label Generated
VendorRequest 226 Missing Accessory Label Generation Error
VendorRequest 227 Missing Accessory Credit Accepted
VendorRequest 228 Missing Accessory Pickup Requested
VendorRequest 229 Missing Accessory Shipped
VendorRequest 240 Partial Credit Accepted
VendorRequest 241 Partial Credit Counter
VendorRequest 242 Partial Credit Impasse
VendorRequest 250 Return Credited
VendorRequest 251 Return Credit Offered
VendorRequest 252 Return Exchanged
VendorRequest 253 Return Received
VendorRequest 254 Return Label Requested
VendorRequest 256 Return Label Generated
VendorRequest 257 Return Label Generation Error
VendorRequest 258 Return Pickup Requested
VendorRequest 259 Return Accepted
VendorRequest 260 Warranty Check Failed
Promotion 130 Starting New
Promotion 131 Ending
Promotion 132 Ended
Promotion 133 Invited
Promotion 134 Accepted
Promotion 135 Rejected
Promotion 136 Cancellation Requested
Promotion 137 Canceled
Promotion 138 Status Change

Update Messages

This endpoint allows a user to update a group of notifications.

URLhttps://api.getquipt.com/v2/notifications/update
 
Methodpost

Parameters:

Name Description Type Required
Read[] The collection of notifications to flag as 'Read'. Guid[] True
Unread[] The collection of notifications to flag as 'Unread'. Guid[] True
Archive[] The collection of notifications to flag as 'Hidden'. Guid[] True

Sample Header:

Sample Request (JSON):

Sample Response (JSON):

Name Description Type
ReportId The id used to lookup report details using the report endpoint. Guid
RecordsReceived The number of records received. Int

Archive Messages

This endpoint allows a user to archive a group of notifications.

URLhttps://api.getquipt.com/v2/notifications/archive
 
Methodpost

Parameters:

Name Description Type Required
Archive[] The collection of notifications to archive. Guid[] True

Sample Header:

Sample Request (JSON):

Sample Response (JSON):

Name Description Type
ReportId The id used to lookup report details using the report endpoint. Guid
RecordsReceived The number of records received. Int

Batch Report

This endpoint allows a user to retrieve the processing report for any batch notification transaction posted via API, ie Archive.

URLhttps://api.getquipt.com/Notifications/Report/{reportId}/{pageSize}/{pageNumber}
 
Methodget

Parameters:

Name Description Type Required
{reportId} The report id. The value is the ReportId property included in the response of any batch endpoint. Guid Yes
{pageSize} The maximum number of records to return. The maximum value is 200. Int Yes
{pageNumber} The page to retrieve. String Yes
&includeLines Flag whether or not to include the line details. Boolean No

Sample Header:

Sample Response (JSON):

Name Description Type
ReportId The report id. Guid
ReportTime The time the report generated. DateTime
ReportStatus The current status of the report. Int
Paging Paging information for the records returned. Paging
Success Whether or not the transaction was successful. Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]

Archive Notification

This endpoint allows a user archive a message in real-time.

URLhttps://api.getquipt.com/v2/notifications/{messageId}/archive
 
Methodpost

Parameters:

Name Description Type Required
{messageId} The message id to archive. Guid Yes

Sample Header:

Sample Response (JSON):

Name Description Type
Id The notification id. Guid
Success Whether or not the transaction was successful. Boolean
Messages One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. Message[]