Order intent to cancel event

This notification occurs when an order is created with the intent to cancel.

When the event occurs, the seller will receive the response payload on the destination URL, as given in the samples.

Event Type: INTENT_TO_CANCEL
Event Version: V1
Resource Name: ORDER

Response parameters

Name	Description	Type
source	Event meta information	Object
eventType	Event for which the notification is received	String
eventTime	Time at which the event occurs	String
eventId	Unique ID of the event	String
payload	Event details	Object
partnerId	Seller’s Partner ID	String
purchaseOrderId	A unique ID associated with the seller’s purchase order	String
customerOrderId	A unique ID associated with the sales order for a specified customer	String
orderDate	The date the customer submitted the sales order	String
estimatedDeliveryDate	The estimated time and date for the delivery of the item	String
estimatedShipDate	The estimated time and date when the item will be shipped	String
orderLines	Purchase Order line information for each item	List of OrderLine
lineNumber	The line number associated with the details for each item in the purchase order	String
sku	A unique ID which identifies the item	String
productName	Name of the item	String
quantity	Details about the quantity	Object
unitOfMeasure	Unit of measurement	String
measurementValue	Quantity value	String
status	Status of the order line. Example: CREATED	String
statusDate	Date of most recent status shown on the order	String
shippingProgramType	Gives shipping program information. Examples: TWO_DAY, THREE_DAY, etc.	String
shippingMethod	Shipping Method. Examples: Value, Expedited, Standard, etc.	String
cancellationReason	Reason for cancellation of PO Line	String
cancelSubReasonCodeDescription	Description of cancellation sub-reason code	String
shipNodeType	Specifies the type of shipNode. Possible values are: SellerFulfilled, WFSFulfilled, and 3PLFulfilled.	String

Sample payload: Intent to cancel

{ source": { "eventType": "INTENT_TO_CANCEL", "eventFilters": null, "eventTime": "2024-05-08T08:38:59.604Z", "eventId": "6152fd40-0d16-11ef-a1eb-f54123823e1e" }, "payload": { "partnerId": "10000680931", "purchaseOrderId": "1805600225946", "customerOrderId": "1594199846496", "orderDate": "2020-07-05T01:05:09+00:00", "estimatedDeliveryDate": "2020-07-17T19:00:00+00:00", "estimatedShipDate": "2020-07-09T03:00:00+00:00", "orderLines": [ { "lineNumber": "1", "sku": "9133KHAKIL", "productName": "Healing Hands Purple Label Women's Tori 5-Pocket Scrub Pant", "quantity": { "unitOfMeasure": "EACH", "measurementValue": "1" }, "status": "PO Created", "statusDate": "2020-07-17T03:19:55.752+00:00", "shippingProgramType": "TWO_DAY", "shippingMethod": "VALUE", "cancellationReason": "Auto-cancelled due to expiry" "cancelSubReasonCodeDescription": "Used the wrong payment method." } ], "shipNodeType": "SellerFulfilled" } }