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

order-confirmed

Get notified when an existing order's attributes are extended or modified.

{
  "key": "string",
  "locale": {
    "appId": "integer",
    "countryCode": "string",
    "currencyCode": "string",
    "languageCode": "string"
  },
  "occurredAt": "datetime",
  "type": "order-confirmed",
  "payload": {
    "id": "integer",
    "address": {
      "billing": {
        "id": "integer",
        "additional": "string",
        "city": "string",
        "countryCode": "string",
        "houseNumber": "string",
        "isDefault": {
          "billing": "boolean",
          "shipping": "boolean"
        },
        "phone": "string",
        "recipient": {
          "firstName": "string",
          "gender": "string",
          "lastName": "string",
          "type": "string"
        },
        "referenceKey": "string",
        "state": "string",
        "street": "string",
        "zipCode": "string",
        "createdAt": "datetime",
        "updatedAt": "datetime"
      },
      "forward": {
        "additional": "string",
        "city": "string",
        "countryCode": "string",
        "houseNumber": "string",
        "recipient": {
          "firstName": "string",
          "gender": "string",
          "lastName": "string",
          "type": "string"
        },
        "state": "string",
        "street": "string",
        "zipCode": "string",
        "createdAt": "datetime",
        "updatedAt": "datetime"
      },
      "shipping": {
        "id": "integer",
        "city": "string",
        "collectionPoint": {
          "customerKey": "string",
          "description": "string",
          "key": "string",
          "type": "string"
        },
        "countryCode": "string",
        "houseNumber": "string",
        "isDefault": {
          "billing": "boolean",
          "shipping": "boolean"
        },
        "phone": "string",
        "recipient": {
          "firstName": "string",
          "gender": "string",
          "lastName": "string",
          "type": "string"
        },
        "referenceKey": "string",
        "state": "string",
        "street": "string",
        "zipCode": "string",
        "createdAt": "datetime",
        "updatedAt": "datetime"
      }
    },
    "basketKey": "string",
    "confirmedAt": "datetime",
    "cost": {
      "appliedReductions": [
        {
          "amount": {
            "absoluteWithTax": "integer",
            "relative": "integer"
          },
          "category": "string",
          "code": "string",
          "displayName": "string",
          "type": "string"
        }
      ],
      "costCapture": "integer",
      "itemGroups": {
        "1234567": {
          "brutto": "integer",
          "bruttoDiscount": "integer",
          "bruttoDiscountWithoutMainProduct": "integer",
          "bruttoWithoutMainProduct": "integer",
          "netto": "integer",
          "nettoWithoutMainProduct": "integer",
          "tax": "integer",
          "taxWithoutMainProduct": "integer"
        }
      },
      "tax": {},
      "withoutTax": "integer",
      "withoutTaxWithMembershipDiscount": "integer",
      "withTax": "integer",
      "withTaxWithMembershipDiscountWithoutServiceCosts": "integer"
    },
    "currencyCode": "string",
    "customer": {
      "id": "integer",
      "authentication": {
        "type": "string"
      },
      "birthDate": "string",
      "customData": {
        "isVip": "boolean"
      },
      "email": "string",
      "firstName": "string",
      "gender": "string",
      "groups": [
        "string",
        "string"
      ],
      "identities": [
        {
          "idpCode": "string"
        },
        {
          "externalUserId": "string",
          "idpCode": "string"
        }
      ],
      "ipAddress": "string",
      "lastName": "string",
      "phone": "string",
      "publicKey": "string",
      "referenceKey": "string",
      "status": {
        "isActive": "boolean",
        "isGuestCustomer": "boolean",
        "isTestCustomer": "boolean"
      },
      "title": "string",
      "type": "string",
      "userAgent": "string",
      "createdAt": "datetime",
      "updatedAt": "datetime"
    },
    "detailedStatus": {
      "billing": {
        "code": "string",
        "name": "string"
      },
      "order": {
        "code": "string",
        "name": "string"
      },
      "shipping": {
        "code": "string",
        "name": "string"
      }
    },
    "invoicedAt": "datetime",
    "items": [
      {
        "availableQuantity": "integer",
        "campaignKey": "string",
        "customData": {
          "key": "string"
        },
        "deliveryForecast": {
          "subsequentDelivery": {
            "key": "string"
          }
        },
        "isManuallyReturnedByCci": "boolean",
        "itemGroup": {
          "id": "string",
          "isMainItem": "boolean",
          "isRequired": "boolean"
        },
        "key": "string",
        "lowestPriorPrice": {
          "relativeDifferenceToPrice": "integer",
          "withTax": "integer"
        },
        "packageId": "integer",
        "price": {
          "appliedReductions": [
            {
              "amount": {
                "absoluteWithTax": "integer",
                "relative": "integer"
              },
              "category": "string",
              "code": "string",
              "type": "string"
            },
            {
              "amount": {
                "absoluteWithTax": "integer",
                "relative": "integer"
              },
              "category": "string",
              "type": "string"
            }
          ],
          "overrideWithoutTax": "integer",
          "overrideWithTax": "integer",
          "reference": {
            "size": "string",
            "unit": "string",
            "withTax": "integer"
          },
          "tax": {
            "vat": {
              "amount": "integer",
              "rate": "integer"
            }
          },
          "undiscountedWithOutTax": "integer",
          "undiscountedWithTax": "integer",
          "withoutTax": "integer",
          "withTax": "integer"
        },
        "product": {
          "id": "integer",
          "advancedAttributes": {
            "materialCompositionTextile": {
              "key": "string",
              "label": "string",
              "values": [
                {
                  "fieldSet": [
                    [
                      {
                        "value": "string"
                      }
                    ]
                  ],
                  "groupSet": [
                    {
                      "fieldSet": [
                        [
                          {
                            "value": "integer"
                          },
                          {
                            "unit": "string"
                          },
                          {
                            "material": "string"
                          }
                        ]
                      ],
                      "groupSet": []
                    }
                  ]
                }
              ]
            }
          },
          "attributes": {
            "description": {
              "key": "string",
              "label": "string",
              "values": [
                {
                  "id": "integer",
                  "label": "string",
                  "value": "string"
                }
              ]
            }
          },
          "categories": [
            [
              {
                "categoryId": "integer",
                "categoryName": "string",
                "categoryProperties": {
                  "priority": {
                    "name": "string",
                    "value": "string"
                  }
                },
                "categoryUrl": "string"
              }
            ]
          ],
          "definingAttributes": [
            {
              "key": "string",
              "label": "string"
            }
          ],
          "images": [
            {
              "attributes": {
                "description": {
                  "key": "string",
                  "label": "string",
                  "values": [
                    {
                      "label": "string"
                    }
                  ]
                }
              },
              "hash": "string"
            }
          ],
          "masterKey": "string",
          "name": "string",
          "createdAt": "datetime",
          "updatedAt": "datetime"
        },
        "promotion": {
          "id": "string",
          "code": "string",
          "displayName": "string",
          "name": "string",
          "version": "string"
        },
        "status": "string",
        "variant": {
          "id": "integer",
          "attributes": {
            "vendorSize": {
              "key": "string",
              "label": "string",
              "values": [
                {
                  "id": "integer",
                  "label": "string",
                  "value": "string"
                }
              ]
            }
          },
          "referenceKey": "string",
          "stock": {
            "customData": {},
            "deliveryForecast": {
              "deliverable": "string",
              "subsequentDelivery": "string"
            },
            "isSellableWithoutStock": "boolean",
            "quantity": "integer",
            "supplierId": "integer"
          },
          "createdAt": "datetime",
          "updatedAt": "datetime"
        },
        "warehouseId": "integer",
        "warehousePackageGroupId": "integer",
        "createdAt": "datetime",
        "updatedAt": "datetime"
      }
    ],
    "membershipDiscount": {
      "membershipCardId": "integer",
      "pointsUsed": "integer",
      "reductionValue": "integer",
      "tax": "integer"
    },
    "packages": [
      {
        "id": "integer",
        "carrierKey": "string",
        "deliveryDate": {
          "maximum": "string",
          "minimum": "string"
        },
        "deliveryStatus": "string",
        "hasExpectedAvailabilityAt": "boolean",
        "returnIdentCode": "string",
        "shipmentKey": "string",
        "tracking": {
          "id": "string",
          "url": "string"
        }
      }
    ],
    "payment": [
      {
        "amount": "integer",
        "data": {
          "creditCardBrand": "string",
          "PayID": "string",
          "success": "boolean",
          "transaction_id": "string",
          "type": "string",
          "UserData": {
            "requestToken": "string"
          },
          "XID": [
            "string"
          ]
        },
        "isGiftCard": "boolean",
        "key": "string",
        "transactionKey": "string"
      }
    ],
    "promotions": [
      {
        "id": "string",
        "code": "string",
        "displayName": "string",
        "reduction": "integer",
        "version": "string"
      }
    ],
    "publicKey": "string",
    "referenceKey": "string",
    "shipping": {
      "deliveredOn": "string",
      "policy": "string"
    },
    "status": "string",
    "vouchers": [
      {
        "id": "integer",
        "applicableItems": [
          {
            "isApplied": "boolean",
            "key": "string"
          },
          {
            "isApplied": "boolean",
            "key": "string"
          }
        ],
        "code": "string",
        "type": "string",
        "value": "integer",
        "voucherId": "integer"
      }
    ],
    "createdAt": "datetime",
    "updatedAt": "datetime"
  },
  "type": "string"
}