docs
  1. Scayle Developer Guides
  2. Customise & Extend
  3. Webhooks
  4. Events
  5. Order-cancelled

order-cancelled

Get notified when all items of an order have been canceled.

{
  "key": "string",
  "meta": {
    "tenantKey": "string",
    "xRequestId": "string"
  },
  "occurredAt": "datetime",
  "type": "order-cancelled",
  "payload": {
    "address": {
      "billing": {
        "id": "integer",
        "referenceKey": "string",
        "street": "string",
        "houseNumber": "string",
        "additional": "string",
        "zipCode": "string",
        "city": "string",
        "countryCode": "string",
        "collectionPoint": {
          "customerKey": "string",
          "description": "string",
          "key": "string",
          "type": "string"
        },
        "isDefault": {
          "billing": "boolean",
          "shipping": "boolean"
        },
        "recipient": {
          "firstName": "string",
          "gender": "string",
          "lastName": "string",
          "title": "string"
        }
      },
      "forward": {
        "id": "integer",
        "referenceKey": "string",
        "street": "string",
        "houseNumber": "string",
        "additional": "string",
        "zipCode": "string",
        "city": "string",
        "countryCode": "string",
        "collectionPoint": {
          "customerKey": "string",
          "description": "string",
          "key": "string",
          "type": "string"
        },
        "isDefault": {
          "billing": "boolean",
          "shipping": "boolean"
        },
        "recipient": {
          "firstName": "string",
          "gender": "string",
          "lastName": "string",
          "title": "string"
        }
      },
      "shipping": {
        "id": "integer",
        "referenceKey": "string",
        "street": "string",
        "houseNumber": "string",
        "additional": "string",
        "zipCode": "string",
        "city": "string",
        "countryCode": "string",
        "collectionPoint": {
          "customerKey": "string",
          "description": "string",
          "key": "string",
          "type": "string"
        },
        "isDefault": {
          "billing": "boolean",
          "shipping": "boolean"
        },
        "recipient": {
          "firstName": "string",
          "gender": "string",
          "lastName": "string",
          "title": "string"
        }
      }
    },
    "basketKey": "string",
    "confirmedAt": "datetime",
    "contacts": [
      {
        "type": "string",
        "value": "string"
      }
    ],
    "cost": {
      "appliedFees": [
        {
          "amount": {
            "withTax": "integer",
            "withoutTax": "integer"
          },
          "category": "string",
          "key": "string",
          "option": "string",
          "tax": {
            "vat": {
              "amount": "integer",
              "rate": "integer"
            }
          }
        }
      ],
      "appliedReductions": [
        {
          "amount": {
            "absoluteWithTax": "integer",
            "relative": "integer"
          },
          "category": "string",
          "type": "string"
        }
      ],
      "tax": {
        "vat": {
          "amount": "integer"
        }
      },
      "withTax": "integer",
      "withoutTax": "integer",
      "withTaxWithMembershipDiscountWithoutServiceCosts": "integer",
      "withoutTaxWithMembershipDiscount": "integer",
      "costCapture": "integer"
    },
    "currencyCode": "string",
    "customer": {
      "id": "integer",
      "referenceKey": "string"
    },
    "id": "integer",
    "invoicedAt": "datetime",
    "items": [
      {
        "id": "integer",
        "availableQuantity": "integer",
        "deliveryForecast": {
          "subsequentDelivery": {
            "key": "string"
          }
        },
        "legacyCustomData": {
          "key": "string"
        },
        "packageId": "integer",
        "price": {
          "appliedReductions": [
            {
              "amount": {
                "absoluteWithTax": "integer",
                "relative": "integer"
              },
              "category": "string",
              "type": "string"
            }
          ],
          "reference": {
            "size": "string",
            "unit": "string",
            "withTax": "integer"
          },
          "tax": {
            "vat": {
              "amount": "integer",
              "rate": "integer"
            }
          },
          "withTax": "integer",
          "withoutTax": "integer"
        },
        "product": {
          "id": "integer",
          "referenceKey": "string"
        },
        "promotion": {
          "id": "string",
          "name": "string",
          "version": "string"
        },
        "key": "string",
        "reservationKey": "string",
        "status": "string",
        "variant": {
          "id": "integer",
          "referenceKey": "string"
        },
        "warehouseId": "integer",
        "itemGroup": {
          "id": "string",
          "isMainItem": "boolean",
          "isRequired": "boolean"
        },
        "campaignKey": "string",
        "merchant": {
          "referenceKey": "string"
        }
      }
    ],
    "legacyCustomData": {
      "score": {
        "generatedOn": "string",
        "result": "string"
      }
    },
    "membershipDiscount": {
      "membershipCardId": "integer",
      "pointsUsed": "integer",
      "reductionValue": "integer",
      "tax": "integer"
    },
    "packages": [
      {
        "carrierKey": "string",
        "deliveryDate": {
          "maximum": "string",
          "minimum": "string"
        },
        "deliveryStatus": "string",
        "id": "integer"
      }
    ],
    "payment": [
      {
        "amount": "integer",
        "data": {
          "CCBrand": "string",
          "CCExpiry": "string",
          "IPCity": "string",
          "IPLatitude": "string",
          "IPLongitude": "string",
          "IPState": "string",
          "IPZone": "string",
          "IPZoneA2": "string"
        },
        "key": "string",
        "transactionKey": "string"
      }
    ],
    "publicKey": "string",
    "referenceKey": "string",
    "shipping": {
      "policy": "string"
    },
    "shopCountry": {
      "id": "integer",
      "shopKey": "string",
      "countryCode": "string",
      "defaultLanguageCode": "string",
      "supportedLanguageCodes": [
        "string",
        "string"
      ],
      "active": "boolean",
      "deleted": "boolean",
      "url": "string",
      "currencyCode": "string",
      "priceGroupKey": "string"
    },
    "status": "string",
    "detailedStatus": {
      "billing": {
        "code": "string",
        "name": "string"
      },
      "order": {
        "code": "string",
        "name": "string"
      },
      "shipping": {
        "code": "string",
        "name": "string"
      }
    },
    "vouchers": [
      {
        "id": "integer",
        "applicableItems": [
          {
            "isApplied": "boolean",
            "key": "string"
          }
        ],
        "code": "string",
        "type": "string",
        "value": "integer",
        "voucherId": "integer"
      }
    ]
  }
}