order-item-cancelled

An order-item-cancelled event is triggered when there is an explicit cancelation request via the Account Area (e.g., Customer cancelled one or multiple items) or via customer service or by a payment provider.

Example:

Properties:

key string
locale object
- appId integer
- countryCode string (minimum length: ) (maximum length: 3)
- currencyCode string (optional) (minimum length: ) (maximum length: 3)
- languageCode string (minimum length: ) (maximum length: 5)
occurredAt string
payload object
- items array
  - id integer (optional)
  - availableQuantity integer (optional)
  - basketItemKey string (optional)
  - campaignKey string (optional)
  - currency string (optional) (minimum length: ) (maximum length: 3)
  - customData object (optional) (object is extensible as desired)
  - deliveryForecast object (optional)
  - isManuallyReturnedByCci boolean (optional)
  - itemGroup **** (optional)
  - key string
  - lowestPriorPrice **** (optional)
  - merchant object (optional)
  - packageId integer
  - price object
  - product object (object is extensible as desired)
  - promotion object (optional)
  - reservationKey string (optional)
  - status enum (available unavailable deliverable undeliverable cancelled returned delivered created pended confirmed delegated partially_shipped shipped delivered cancelled)
  - variant object (object is extensible as desired)
  - warehouseId null,integer (optional)
  - warehousePackageGroupId null,integer (optional)
  - createdAt string (date-time ISO 8601)
  - updatedAt string (date-time ISO 8601)
- order object (object is extensible as desired)
  - id integer
  - address object (optional)
  - basketKey string
  - confirmedAt string (date-time validation) (optional)
  - contacts array (optional)
  - cost object
  - currencyCode string
  - customData object (optional) (object is extensible as desired)
  - customer object (optional)
  - detailedStatus object (optional) (object is extensible as desired)
  - invoicedAt string (date-time validation) (optional)
  - items array (optional)
  - loyaltyCard object (optional)
  - membershipDiscount object (optional)
  - packages array (optional)
  - payment array (optional)
  - promotions array (optional)
  - publicKey string (optional) (minimum length: ) (maximum length: 100)
  - referenceKey string (optional) (minimum length: ) (maximum length: 100)
  - shipping object (optional)
  - shop object (optional)
  - status enum (order_open payment_pending payment_reserved invoice_completed cancellation_pending cancellation_completed invoice_partially_completed)
  - vouchers array (optional)
  - createdAt string (date-time ISO 8601)
  - updatedAt string (date-time ISO 8601)
type enum (order-item-cancelled)