CancellationDetails

Version 2024-04-01

Overview

Details about a Cancellation

Fields

Field Description

additionalComments (String)

Any additional comments that merchants want to associate with the cancellation details.

aliases ([Alias])

A list of aliases associated with Buy With Prime Cancellation. This can include unique identifiers for cancellation requests in merchant's store.

canceledFor (CanceledFor)

Captures the cancellation details for entire order.

createdAt (String)

The Date Time in ISO 8601 format when cancellation was requested.

reason (String)

Reason for issuing the Cancellation.

Constrained to one of the following values

value	description
ORDERED_BY_MISTAKE	Customer made mistakes while placing the order.
ITEMS_ARRIVING_LATE	Customer canceled because some items would not arrive on time.
INCORRECT_SHIPPING_ADDRESS	Customer used incorrect shipping address while placing the order.
OUT_OF_STOCK	Item went out of stock after the order was placed and can't be delivered.
PAYMENT_ISSUE	Issue charging a shopper for the purchase.
OTHER	Other

refundDetails ([RefundDetails])

Refunds that were issued as part of a cancellation request. BwP tries to issue refunds to shoppers in cases where shoppers were charged before a cancellation was requested. If shoppers were not charged, BwP does not try to issue refunds.

requestedBy (String)

Details about the Cancellation requestor.

Constrained to one of the following

value	description
SHOPPER	Shopper initiated cancellation
MERCHANT	Merchant initiated cancellation
BWP_CUSTOMER_SERVICE_AGENT	BwP Customer Service Agent initiated cancellation

state (String)

Represents the state of Cancellation.

The value is constrained to one of the following

value	description
PENDING	Cancellation is requested and BwP is trying to cancel.
SUCCESS	Cancellation is successful and items will not be
delivered to shoppers. Any charges that have been levied on shoppers will be refunded.
REJECTED	BwP was unable to cancel ordered items. Shoppers will
receive the ordered items and will be charged appropriately. They can initiate
returns after receiving the items
PARTIAL_SUCCESS	Represents that BwP was able to cancel some items and
unable to cancel some items. This is a terminal state meaning that items that
were not canceled were fulfilled

updatedAt (String)

The Date Time in ISO 8601 format when cancellation request was last updated.

Updated about 2 months ago