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

order-item-unshippable

Get notified whenever an order item is unshippable.

{
  "key": "string",
  "meta": {
    "tenantKey": "string",
    "xRequestId": "string"
  },
  "occurredAt": "datetime",
  "type": "order-item-unshippable",
  "version": "integer",
  "payload": {
    "order": {
      "id": "integer",
      "basketKey": "string",
      "cost": {
        "tax": {
          "vat": {
            "amount": "integer"
          }
        },
        "withTax": "integer",
        "withoutTax": "integer",
        "appliedFees": [
          {
            "category": "string",
            "key": "string",
            "option": "string",
            "tax": {
              "vat": {
                "amount": "integer",
                "rate": "integer"
              }
            },
            "amount": {
              "withoutTax": "integer",
              "withTax": "integer"
            }
          }
        ],
        "withTaxWithMembershipDiscountWithoutServiceCosts": "integer",
        "withoutTaxWithMembershipDiscount": "integer",
        "costCapture": "integer"
      },
      "currencyCode": "string",
      "status": "string",
      "detailedStatus": {
        "billing": {
          "code": "string",
          "name": "string"
        },
        "order": {
          "code": "string",
          "name": "string"
        },
        "shipping": {
          "code": "string",
          "name": "string"
        }
      },
      "address": {
        "billing": {
          "id": "integer",
          "street": "string",
          "houseNumber": "string",
          "zipCode": "string",
          "city": "string",
          "countryCode": "string",
          "isDefault": {
            "billing": "boolean",
            "shipping": "boolean"
          },
          "recipient": {
            "firstName": "string",
            "lastName": "string",
            "gender": "string",
            "type": "string"
          }
        },
        "shipping": {
          "id": "integer",
          "street": "string",
          "houseNumber": "string",
          "zipCode": "string",
          "city": "string",
          "countryCode": "string",
          "isDefault": {
            "billing": "boolean",
            "shipping": "boolean"
          },
          "recipient": {
            "firstName": "string",
            "lastName": "string",
            "gender": "string",
            "type": "string"
          }
        }
      },
      "contacts": [
        {
          "type": "string"
        }
      ],
      "items": [
        {
          "packageId": "integer",
          "price": {
            "withTax": "integer",
            "withoutTax": "integer",
            "appliedReductions": [
              {
                "category": "string",
                "type": "string",
                "amount": {
                  "relative": "integer",
                  "absoluteWithTax": "integer"
                }
              }
            ],
            "tax": {
              "vat": {
                "amount": "integer",
                "rate": "integer"
              }
            },
            "overrideWithoutTax": "integer",
            "overrideWithTax": "integer",
            "undiscountedWithOutTax": "integer",
            "undiscountedWithTax": "integer"
          },
          "status": "string",
          "key": "string",
          "product": {
            "id": "integer",
            "name": "string"
          },
          "id": "integer",
          "warehouseId": "integer",
          "variant": {
            "id": "integer",
            "referenceKey": "string",
            "stock": {
              "supplierId": "integer"
            }
          },
          "currency": "string",
          "lowestPriorPrice": {
            "relativeDifferenceToPrice": "integer",
            "withTax": "integer"
          },
          "itemGroup": "object",
          "merchant": {
            "referenceKey": "string"
          },
          "createdAt": "datetime",
          "updatedAt": "datetime"
        }
      ],
      "payment": [
        {
          "key": "string",
          "amount": "integer",
          "data": {
            "amount": {
              "currency": "string",
              "value": "integer"
            },
            "creditCardBrand": "string",
            "merchantAccount": "string",
            "pspReference": "string",
            "success": "boolean"
          },
          "transactionKey": "string"
        }
      ],
      "customer": {
        "id": "integer",
        "firstName": "string",
        "lastName": "string",
        "gender": "string",
        "email": "string",
        "type": "string",
        "createdAt": "datetime",
        "updatedAt": "datetime",
        "status": {
          "isActive": "boolean",
          "isGuestCustomer": "boolean"
        }
      },
      "packages": [
        {
          "id": "integer",
          "carrierKey": "object",
          "deliveryStatus": "string",
          "deliveryDate": {
            "maximum": "string",
            "minimum": "string"
          },
          "shipmentKey": "string",
          "tracking": {
            "id": "string"
          }
        }
      ],
      "shipping": {
        "policy": "string",
        "deliveryCosts": "integer",
        "expressDeliveryCosts": "integer"
      },
      "referenceKey": "string",
      "updatedAt": "datetime",
      "createdAt": "datetime",
      "confirmedAt": "datetime",
      "shopCountry": {
        "id": "integer",
        "shopKey": "string",
        "countryCode": "string",
        "defaultLanguageCode": "string",
        "supportedLanguageCodes": [],
        "priceGroupKey": "object",
        "url": "string",
        "active": "boolean",
        "currencyCode": "string",
        "deleted": "boolean"
      }
    },
    "items": [
      {
        "packageId": "integer",
        "price": {
          "withTax": "integer",
          "withoutTax": "integer",
          "appliedReductions": [
            {
              "category": "string",
              "type": "string",
              "amount": {
                "relative": "integer",
                "absoluteWithTax": "integer"
              }
            }
          ],
          "tax": {
            "vat": {
              "amount": "integer",
              "rate": "integer"
            }
          },
          "overrideWithoutTax": "integer",
          "overrideWithTax": "integer",
          "undiscountedWithOutTax": "integer",
          "undiscountedWithTax": "integer"
        },
        "status": "string",
        "key": "string",
        "product": {
          "id": "integer",
          "name": "string"
        },
        "id": "integer",
        "warehouseId": "integer",
        "variant": {
          "id": "integer",
          "referenceKey": "string",
          "stock": {
            "supplierId": "integer"
          }
        },
        "currency": "string",
        "lowestPriorPrice": {
          "relativeDifferenceToPrice": "integer",
          "withTax": "integer"
        },
        "itemGroup": "object",
        "merchant": {
          "referenceKey": "string"
        },
        "createdAt": "datetime",
        "updatedAt": "datetime"
      }
    ],
    "shopCountry": {
      "id": "integer",
      "shopKey": "string",
      "countryCode": "string",
      "defaultLanguageCode": "string",
      "supportedLanguageCodes": [],
      "priceGroupKey": "object",
      "url": "string",
      "active": "boolean",
      "currencyCode": "string",
      "deleted": "boolean"
    }
  }
}