order-custom-data-updated

An order-custom-data-updated event is triggered when the legacyCustomData field on an order or order item is updated. In addition to order data, this webhook also sends a JSON payload containing the differences between the previous and updated custom data, allowing systems to track changes effectively.

Example:

Properties:

key string
meta object
- xRequestId string
occurredAt string
type string
payload object
- id integer
- basketKey string
- cost object
  - tax object
    - vat object (optional)
      - amount float
  - withTax integer
  - withoutTax integer
  - hasExternalPrices bool
  - appliedFees array<object> (optional)
    - category string
    - key string
    - option string (optional)
    - tax object
      - vat object (optional)
        amount float
    - amount object
      - withTax integer
      - withoutTax integer
  - appliedReductions array<object> (optional)
    - id integer (optional)
    - category string
    - type string
    - code string (optional)
    - displayName string (optional)
    - amount object (optional)
      - relative float
      - absoluteWithTax int
  - withTaxWithMembershipDiscountWithoutServiceCosts integer (optional)
  - withoutTaxWithMembershipDiscount integer (optional)
  - costCapture integer (optional)
  - itemGroups array (optional)
- currencyCode string
- status string (order_open payment_pending payment_reserved invoice_completed cancellation_pending cancellation_completed invoice_partially_completed)
- detailedStatus object (optional)
  - billing object
    - code string
    - name string
  - order object
    - code string
    - name string
  - shipping object
    - code string
    - name string
- legacyCustomData object (optional) (object is extensible as desired)
- address object (optional)
  - billing object
    - id integer (optional)
    - referenceKey string (optional) (min length: 1, maximum length: 100)
    - street string
    - houseNumber string (optional)
    - additional string (optional)
    - zipCode string
    - city string
    - countryCode string (exact length: 3)
    - collectionPoint object (optional)
      - customerKey string (optional)
      - description string (optional)
      - key string
      - type string
    - isDefault object
      - billing boolean
      - shipping boolean
    - recipient object
      - firstName string (optional)
      - gender enum (m f d n) (optional)
      - lastName string
      - title string (maximum length: 30)
      - type string (personal retail organization family)
    - phone string (optional)
    - state string (optional)
    - shopCountry object (optional)
      - id integer
      - shopKey string (exact length: 2) (optional)
      - countryCode string (exact length: 2) (optional)
      - defaultLanguageCode string (maximum length: 5)
      - supportedLanguageCodes array<string> (optional) (maximum length of an array item: 5)
      - priceGroupKey string (optional)
      - smartSortingKey string (optional)
      - url string (optional)
      - active boolean
      - currencyCode string (optional)
      - deleted boolean
    - type string (shipping billing)
  - forward object (optional)
    - id integer (optional)
    - referenceKey string (optional) (min length: 1, maximum length: 100)
    - street string
    - houseNumber string (optional)
    - additional string (optional)
    - zipCode string
    - city string
    - countryCode string (exact length: 3)
    - collectionPoint object (optional)
      - customerKey string (optional)
      - description string (optional)
      - key string
      - type string
    - isDefault object
      - billing boolean
      - shipping boolean
    - recipient object
      - firstName string (optional)
      - gender enum (m f d n) (optional)
      - lastName string
      - title string (maximum length: 30)
      - type string (personal retail organization family)
    - phone string (optional)
    - state string (optional)
    - shopCountry object (optional)
      - id integer
      - shopKey string (exact length: 2) (optional)
      - countryCode string (exact length: 2) (optional)
      - defaultLanguageCode string (maximum length: 5)
      - supportedLanguageCodes array<string> (optional) (maximum length of an array item: 5)
      - priceGroupKey string (optional)
      - smartSortingKey string (optional)
      - url string (optional)
      - active boolean
      - currencyCode string (optional)
      - deleted boolean
    - type string (shipping billing)
  - shipping object
    - id integer (optional)
    - referenceKey string (optional) (min length: 1, maximum length: 100)
    - street string
    - houseNumber string (optional)
    - additional string (optional)
    - zipCode string
    - city string
    - countryCode string (exact length: 3)
    - collectionPoint object (optional)
      - customerKey string (optional)
      - description string (optional)
      - key string
      - type string
    - isDefault object
      - billing boolean
      - shipping boolean
    - recipient object
      - firstName string (optional)
      - gender enum (m f d n) (optional)
      - lastName string
      - title string (maximum length: 30)
      - type string (personal retail organization family)
    - phone string (optional)
    - state string (optional)
    - shopCountry object (optional)
      - id integer
      - shopKey string (exact length: 2) (optional)
      - countryCode string (exact length: 2) (optional)
      - defaultLanguageCode string (maximum length: 5)
      - supportedLanguageCodes array<string> (optional) (maximum length of an array item: 5)
      - priceGroupKey string (optional)
      - smartSortingKey string (optional)
      - url string (optional)
      - active boolean
      - currencyCode string (optional)
      - deleted boolean
    - type string (shipping billing)
- contacts object (optional)
  - type string (optional)
  - value string (optional)
- items array<object> (optional)
  - packageId integer
  - price object
    - withTax int
    - withoutTax int
    - appliedReductions object (optional)
      - id string (optional)
      - category string
      - type string
      - code string (optional)
      - displayName string (optional)
      - amount object
        relative float
        absoluteWithTax int
    - tax object (optional)
      - vat object (optional)
        amount float
        rate float
    - reference object (optional)
      - withTax int
      - unit string
      - size string
    - absoluteVoucherReducedPrice
      - tax object (optional)
        vat object (optional)
        amount float
        rate float
      - withTax int (optional)
      - withoutTax int (optional)
    - overrideWithoutTax int (optional)
    - overrideWithTax int (optional)
    - undiscountedWithOutTax int (optional)
    - undiscountedWithTax int (optional)
  - status enum (available unavailable deliverable undeliverable cancelled returned delivered created pended confirmed delegated partially_shipped shipped delivered cancelled)
  - key string
  - product object
    - id integer (optional)
    - name string (optional)
    - images array<object> (optional)
      - hash string
  - id integer (optional)
  - warehouseId integer (optional)
  - variant object
    - id integer (optional)
    - referenceKey string (optional)
    - stock object (optional)
      - supplierId integer
  - reservationKey string (optional)
  - availableQuantity integer (optional)
  - basketItemKey string (optional)
  - deliveryForecast object (optional)
    - subsequentDelivery object (optional)
      - key string (optional)
    - deliverable object (optional)
      - key string
  - promotion object (optional)
    - id string
    - name string
    - version string
    - displayName string (optional)
    - code string (optional)
  - promotions array<object> (optional)
    - id string
    - name string
    - version string
    - displayName string (optional)
    - code string (optional)
  - campaignKey string (optional)
  - currency string (optional) (maximum length: 3)
  - lowestPriorPrice object (optional)
    - relativeDifferenceToPrice float
    - withTax integer
  - itemGroup object (optional)
    - id string
    - isMainItem boolean
    - isRequired boolean
  - merchant object (optional)
    - referenceKey string
  - createdAt string (date-time ISO 8601)
  - updatedAt string (date-time ISO 8601)
  - delegatedAt string (date-time ISO 8601)
  - shippedAt string (date-time ISO 8601)
  - cancelledAt string (date-time ISO 8601)
  - returnedAt string (date-time ISO 8601)
  - legacyCustomDataDiff array (optional)
- payment array<object> (optional)
  - key string (optional)
  - amount integer (optional)
  - data object (optional) (object is extensible as desired)
  - transactionKey string (optional)
  - installment object (optional)
    - amount integer
    - type string
  - options object (optional)
    - countOfInstallments integer (optional)
    - hasPaybreak boolean (optional)
  - isGiftCard boolean (optional)
- customer object (optional)
  - id string (optional)
  - referenceKey string (optional) (min length: 1, max length: 100)
  - firstName string (optional)
  - lastName string
  - gender enum (m f d n) (optional)
  - birthDate string (date ISO 8601)(optional)
  - email string (optional)
  - phone string (optional)
  - publicKey string (optional) (min length: 1, max length: 100)
  - title string (optional) (maximum length: 30)
  - type string
  - groups array<string> (optional)
  - hasPassword boolean
  - identities array (optional)
    - externalUserId string (optional)
    - identityProviderCode string (optional)
  - createdAt string (date-time ISO 8601)(optional)
  - updatedAt string (date-time ISO 8601) (optional)
  - status object
    - isActive boolean
    - isGuestCustomer boolean
- invoicedAt string (date-time ISO 8601) (optional)
- membershipDiscount object (optional)
  - membershipCardId integer (optional)
  - pointsUsed integer (optional)
  - reductionValue integer (optional)
  - tax integer (optional)
- packages array<object> (optional)
  - id integer
  - shipmentKey string (optional)
  - carrierKey string (optional)
  - deliveryDate object
  - deliveryStatus enum (open shipment_pending delegation_pending shipment_completed cancellation_completed)
  - tracking object (optional)
- publicKey string (optional) (maximum length: 100)
- shipping object (optional)
  - policy string
  - deliveredOn string (optional)
  - deliveryCosts integer (optional)
  - expressDeliveryCosts integer (optional)
- vouchers array<object> (optional)
  - id integer
  - applicableItems array (optional)
  - code string
  - type enum (absolute relative)
  - value number
  - applicableItems array<object> (optional)
    - isApplied boolean (optional)
    - key string (optional)
- referenceKey string (optional) (maximum length: 100)
- campaignKey string (optional)
- updatedAt string (date-time ISO 8601) (optional)
- createdAt string (date-time ISO 8601) (optional)
- confirmedAt string (date-time ISO 8601) (optional)
- shopCountry object (optional)
  - id integer
  - shopKey string (exact length: 2) (optional)
  - countryCode string (exact length: 2) (optional)
  - defaultLanguageCode string (maximum length: 5)
  - supportedLanguageCodes array<string> (optional) (maximum length of an array item: 5)
  - priceGroupKey string (optional)
  - smartSortingKey string (optional)
  - url string (optional)
  - active boolean
  - currencyCode string (optional)
  - deleted boolean
- loyaltyCard object (optional)
  - points integer
  - provider string ([A-Za-z])
  - cardNumber string (optional)
- promotion object (optional)
  - id string (optional)
  - code string (optional)
  - displayName string (optional)
  - reduction string (optional)
  - version string (optional)
- channel object (optional)
  - id integer (optional)
  - key string (optional)
  - name string (optional)
  - type string (optional)
- legacyCustomDataDiff array (optional)