Order intent to cancel event
This notification occurs when a customer indicates they want to cancel an order or specific line before it ships. Use this event to pause fulfillment, attempt a line-level cancellation, and notify your customer support team. Walmart sends the JSON payload to your configured destination URL.
Event metadata
- Event Type: INTENT_TO_CANCEL
- Event Version: V1
- Resource Name: ORDER
Response parameters
| Name | Description | Type |
|---|---|---|
| source | Metadata about the event | Object |
| eventType | Event for which the notification is received | String |
| eventTime | Timestamp of when the event occurred | String |
| eventId | Unique identifier of the event | String |
| payload | Event-specific details | Object |
| partnerId | Seller’s partner ID | String |
| purchaseOrderId | A unique identifier associated with the seller’s purchase order | String |
| customerOrderId | A unique identifier 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 | Line number within the purchase order | String |
| sku | Stock Keeping Unit - Unique identifier which identifies the item | String |
| productName | Name of the item | String |
| quantity | Quantity object for the line | Object |
| unitOfMeasure | Unit of measurement | String |
| measurementValue | Quantity value (numeric string). Example: 1 | String |
| status | Status of the order line. Example: CREATED | String |
| statusDate | Date and time of most recent line status was set on the order. (ISO-8601, UTC) | String |
| shippingProgramType | Shipping program information. Examples: TWO_DAY, THREE_DAY | String |
| shippingMethod | Shipping method. Examples: Value, Expedited, Standard | String |
| cancellationReason | Reason associated with cancellation or PO line, when present. | String |
| cancelSubReasonCodeDescription | Additional context for the cancellation reason, when present. | 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" } }
Updated 1 day ago