Events
This page covers the events that our Webhooks send.
Webhook Events
| Name | Description |
|---|---|
customer-created | Occurs whenever a new customer is registered or connected via a social network on the checkout application. |
customer-updated | Occurs whenever an existing customer's attributes are extended or modified. |
customer-login | Triggered on customer login. |
customer-logout | Triggered on customer logout. |
customer-anonymized | Occurs whenever an existing customer's data is removed from the system at the customer's request. |
customer-password-reset | Triggered on customer password reset. |
customer-address-created | Triggered whenever a customer saves a new address. |
customer-address-updated | Triggered whenever a customer updates an existing address. |
customer-address-deleted | Triggered whenever a customer deletes an existing address. |
order-confirmed | Occurs when payment reservation has been successfully completed, and the order is confirmed. |
order-invoiced | Occurs when an invoice for an order is generated. |
order-corrective-invoiced | Occurs whenever an order or a part of it has been returned, and a corrective invoice is generated. |
order-canceled | Occurs whenever all items in an order have been canceled. |
order-item-out-of-stock | Occurs during order delegation whenever an item is removed from the order, due to being out-of-stock when delegated to the merchant. |
order-item-returned | Occurs whenever an item is returned by the customer. |
order-item-canceled | Occurs whenever an item is canceled. |
order-item-unshippable | Occurs whenever an item is unshippable. |
order-package-shipped | Occurs whenever an order package is shipped. |
payment-capture | Occurs whenever a payment capture occurs within an order. |
payment-refund | Occurs whenever a payment is refunded for an order. |
newsletter-subscribed | Triggered whenever a customer subscribes to a newsletter during Checkout. |
product-updated | Occurs whenever a product is updated. |
product-master-updated | Occurs whenever a product master is updated. |
product-variant-prices-updated | Occurs whenever a product variant price is updated. |
product-variant-availability-updated | Occurs whenever a product variant availability is updated. |
product-variant-stock-updated | Occurs whenever a product variant stock is updated. |
shop-category-tree-updated | Occurs whenever a shop category tree is updated. |
customer-created
Get notified whenever a new customer is registered or connected via a social network.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "customer-created",
"version": "integer",
"payload": {
"id": "integer",
"firstName": "string",
"lastName": "string",
"gender": "string",
"email": "string",
"type": "string",
"groups": [
"string"
],
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
},
"company": {
"id": "integer",
"name": "string"
},
"shopCountry": {
"id": "integer",
"shopKey": "string",
"countryCode": "string",
"defaultLanguageCode": "string",
"supportedLanguageCodes": [],
"priceGroupKey": "object",
"url": "string",
"active": "boolean",
"currencyCode": "string",
"deleted": "boolean"
}
}
}
customer-updated
Get notified when an existing customer's attributes are extended or modified.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "customer-updated",
"version": "integer",
"payload": {
"id": "integer",
"referenceKey": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"email": "string",
"type": "string",
"groups": [
"string"
],
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
},
"company": {
"id": "integer",
"name": "string"
},
"shopCountry": {
"id": "integer",
"shopKey": "string",
"countryCode": "string",
"defaultLanguageCode": "string",
"supportedLanguageCodes": [],
"priceGroupKey": "object",
"url": "string",
"active": "boolean",
"currencyCode": "string",
"deleted": "boolean"
}
}
}
customer-anonymized
Get notified when an existing customer's data is removed from the system due to the customer's request.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "customer-anonymized",
"version": "integer",
"payload": {
"id": "integer",
"referenceKey": "string",
"publicKey": "string"
}
}
customer-login
Get notified whenever an existing customer logs into the system.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "customer-login",
"version": "integer",
"payload": {
"id": "integer",
"referenceKey": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"birthDate": "string",
"email": "string",
"publicKey": "string",
"type": "string",
"groups": [
"string"
],
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
},
"company": {
"id": "integer",
"name": "string"
},
"shopCountry": {
"id": "integer",
"shopKey": "string",
"countryCode": "string",
"defaultLanguageCode": "string",
"supportedLanguageCodes": [],
"priceGroupKey": "object",
"url": "string",
"active": "boolean",
"currencyCode": "string",
"deleted": "boolean"
}
}
}
customer-logout
Get notified whenever an existing customer logs out of the system.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "customer-logout",
"version": "integer",
"payload": {
"id": "integer",
"referenceKey": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"birthDate": "string",
"email": "string",
"publicKey": "string",
"type": "string",
"groups": [
"string"
],
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
},
"company": {
"id": "integer",
"name": "string"
},
"shopCountry": {
"id": "integer",
"shopKey": "string",
"countryCode": "string",
"defaultLanguageCode": "string",
"supportedLanguageCodes": [],
"priceGroupKey": "object",
"url": "string",
"active": "boolean",
"currencyCode": "string",
"deleted": "boolean"
}
}
}
customer-password-reset
Get notified when an existing customer resets the password.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "customer-password-reset",
"version": "integer",
"payload": {
"customer": {
"id": "integer",
"referenceKey": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"email": "string",
"publicKey": "string",
"type": "string",
"groups": [
"string"
],
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
},
"company": {
"id": "integer",
"name": "string"
}
},
"url": "string",
"expiresAt": "datetime",
"shopCountry": {
"id": "integer",
"shopKey": "string",
"countryCode": "string",
"defaultLanguageCode": "string",
"supportedLanguageCodes": [],
"priceGroupKey": "object",
"url": "string",
"active": "boolean",
"currencyCode": "string",
"deleted": "boolean"
}
}
}
customer-address-created
Get notified whenever a customer saves a new address.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "customer-address-created",
"version": "integer",
"payload": {
"customer": {
"id": "integer",
"referenceKey": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"email": "string",
"type": "string",
"groups": [
"string"
],
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
},
"company": {
"id": "integer",
"name": "string"
}
},
"address": {
"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"
}
},
"shopCountry": {
"id": "integer",
"shopKey": "string",
"countryCode": "string",
"defaultLanguageCode": "string",
"supportedLanguageCodes": [],
"priceGroupKey": "object",
"url": "string",
"active": "boolean",
"currencyCode": "string",
"deleted": "boolean"
}
}
}
customer-address-updated
Get notified whenever a customer updates an existing address.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "customer-address-updated",
"version": "integer",
"payload": {
"customer": {
"id": "integer",
"referenceKey": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"email": "string",
"title": "string",
"type": "string",
"groups": [
"string"
],
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
},
"company": {
"id": "integer",
"name": "string"
}
},
"address": {
"id": "integer",
"street": "string",
"houseNumber": "string",
"additional": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"isDefault": {
"billing": "boolean",
"shipping": "boolean"
},
"recipient": {
"firstName": "string",
"lastName": "string",
"gender": "string",
"type": "string"
}
},
"shopCountry": {
"id": "integer",
"shopKey": "string",
"countryCode": "string",
"defaultLanguageCode": "string",
"supportedLanguageCodes": [],
"priceGroupKey": "object",
"url": "string",
"active": "boolean",
"currencyCode": "string",
"deleted": "boolean"
}
}
}
customer-address-deleted
Get notified whenever a customer deletes an existing address.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "customer-address-deleted",
"version": "integer",
"payload": {
"customer": {
"id": "integer",
"referenceKey": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"email": "string",
"title": "string",
"type": "string",
"groups": [
"string"
],
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
},
"company": {
"id": "integer",
"name": "string"
}
},
"address": {
"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"
}
},
"shopCountry": {
"id": "integer",
"shopKey": "string",
"countryCode": "string",
"defaultLanguageCode": "string",
"supportedLanguageCodes": [],
"priceGroupKey": "object",
"url": "string",
"active": "boolean",
"currencyCode": "string",
"deleted": "boolean"
}
}
}
order-confirmed
Get notified when an existing order's attributes are extended or modified.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "order-confirmed",
"version": "integer",
"payload": {
"id": "integer",
"basketKey": "string",
"cost": {
"tax": {
"vat": {
"amount": "integer"
}
},
"withTax": "integer",
"withoutTax": "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"
}
},
"campaignKey": "string",
"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"
},
"pspReference": "string",
"success": "boolean",
"type": "string"
},
"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": "string",
"deliveryStatus": "string",
"deliveryDate": {
"maximum": "string",
"minimum": "string"
}
}
],
"shipping": {
"policy": "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"
}
}
}
order-invoiced
Get notified when an existing order's data is removed from the system due to the customer's request.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "order-invoiced",
"version": "integer",
"payload": {
"id": "integer",
"basketKey": "string",
"cost": {
"tax": {
"vat": {
"amount": "integer"
}
},
"withTax": "integer",
"withoutTax": "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",
"value": "string"
}
],
"items": [
{
"packageId": "integer",
"price": {
"withTax": "integer",
"withoutTax": "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",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
}
],
"payment": [
{
"key": "string",
"amount": "integer",
"data": {
"descriptor": "string",
"profile_id": "string",
"success": "boolean",
"transaction_id": "string",
"type": "string"
},
"transactionKey": "string"
}
],
"customer": {
"id": "integer",
"firstName": "string",
"lastName": "string",
"gender": "string",
"birthDate": "string",
"email": "string",
"phone": "string",
"type": "string",
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
}
},
"invoicedAt": "datetime",
"packages": [
{
"id": "integer",
"carrierKey": "string",
"deliveryStatus": "string",
"deliveryDate": {
"maximum": "string",
"minimum": "string"
},
"shipmentKey": "string",
"tracking": {
"id": "string",
"url": "string"
}
}
],
"shipping": {
"policy": "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"
}
}
}
order-corrective-invoiced
Get notified when an an order or a part of it has been returned, and a corrective invoice is generated.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "order-corrective-invoiced",
"version": "integer",
"payload": {
"id": "integer",
"basketKey": "string",
"cost": {
"tax": {
"vat": {
"amount": "integer"
}
},
"withTax": "integer",
"withoutTax": "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",
"value": "string"
}
],
"items": [
{
"packageId": "integer",
"price": {
"withTax": "integer",
"withoutTax": "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",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
}
],
"payment": [
{
"key": "string",
"amount": "integer",
"data": {
"descriptor": "string",
"profile_id": "string",
"success": "boolean",
"transaction_id": "string",
"type": "string"
},
"transactionKey": "string"
}
],
"customer": {
"id": "integer",
"firstName": "string",
"lastName": "string",
"gender": "string",
"birthDate": "string",
"email": "string",
"phone": "string",
"type": "string",
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
}
},
"invoicedAt": "datetime",
"packages": [
{
"id": "integer",
"carrierKey": "string",
"deliveryStatus": "string",
"deliveryDate": {
"maximum": "string",
"minimum": "string"
},
"shipmentKey": "string",
"tracking": {
"id": "string",
"url": "string"
}
}
],
"shipping": {
"policy": "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"
}
}
}
order-canceled
Get notified when all items of an order have been canceled.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "string",
"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"
}
]
}
}
order-item-out-of-stock
Get notified whenever an item is removed from the order, due to being out-of-stock, when delegated to the merchant.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "order-item-out-of-stock",
"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",
"additional": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"isDefault": {
"billing": "boolean",
"shipping": "boolean"
},
"recipient": {
"firstName": "string",
"lastName": "string",
"gender": "string",
"type": "string"
}
},
"shipping": {
"id": "integer",
"referenceKey": "string",
"street": "string",
"houseNumber": "string",
"additional": "string",
"zipCode": "string",
"city": "string",
"countryCode": "string",
"isDefault": {
"billing": "boolean",
"shipping": "boolean"
},
"recipient": {
"firstName": "string",
"lastName": "string",
"gender": "string",
"type": "string"
}
}
},
"contacts": [
{
"type": "string",
"value": "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"
}
},
"promotion": {
"id": "string",
"name": "string",
"version": "string"
},
"currency": "string",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
}
],
"payment": [
{
"key": "string",
"amount": "integer",
"data": {
"amount": "integer",
"giftCardCode": "string",
"success": "boolean",
"transaction_id": "string",
"type": "string"
},
"transactionKey": "string"
}
],
"customer": {
"id": "integer",
"referenceKey": "string",
"firstName": "string",
"lastName": "string",
"birthDate": "string",
"email": "string",
"phone": "string",
"type": "string",
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
}
},
"packages": [
{
"id": "integer",
"carrierKey": "string",
"deliveryStatus": "string",
"deliveryDate": {
"maximum": "string",
"minimum": "string"
}
}
],
"shipping": {
"policy": "string",
"deliveryCosts": "integer",
"expressDeliveryCosts": "integer"
},
"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"
},
"loyaltyCard": {
"cardNumber": "string",
"points": "integer",
"provider": "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"
}
},
"promotion": {
"id": "string",
"name": "string",
"version": "string"
},
"currency": "string",
"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"
}
}
}
order-item-returned
Get notified whenever an order item is returned.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "order-item-returned",
"version": "integer",
"payload": {
"order": {
"id": "integer",
"basketKey": "string",
"cost": {
"tax": {
"vat": {
"amount": "integer"
}
},
"withTax": "integer",
"withoutTax": "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",
"title": "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",
"title": "string",
"gender": "string",
"type": "string"
}
}
},
"contacts": [
{
"type": "string",
"value": "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"
},
"pspReference": "string",
"success": "boolean",
"type": "string"
},
"transactionKey": "string"
}
],
"customer": {
"id": "integer",
"referenceKey": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"birthDate": "string",
"email": "string",
"phone": "string",
"title": "string",
"type": "string",
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
}
},
"invoicedAt": "datetime",
"packages": [
{
"id": "integer",
"carrierKey": "string",
"deliveryStatus": "string",
"deliveryDate": {
"maximum": "string",
"minimum": "string"
},
"shipmentKey": "string",
"tracking": {
"id": "string",
"url": "string"
}
}
],
"shipping": {
"policy": "string"
},
"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"
}
}
}
order-item-canceled
Get notified whenever an order item is canceled.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "string",
"payload": {
"order": {
"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": [
{
"applicableItems": [
{
"isApplied": "boolean",
"key": "string"
}
],
"code": "string",
"id": "integer",
"type": "string",
"value": "integer"
}
]
},
"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",
"state": "string",
"master": {
"referenceKey": "string",
"categories": {
"isLocked": "boolean",
"paths": [
[
"string",
"string",
"string"
]
]
}
},
"name": {
"de_DE": "string",
"en_GB": "string"
},
"attributes": [],
"images": []
},
"key": "string",
"reservationKey": "string",
"status": "string",
"variant": {
"id": "integer",
"referenceKey": "string",
"attributes": [
{
"name": "string",
"type": "string",
"value": "string",
"isLocked": "boolean"
}
]
},
"warehouseId": "integer",
"itemGroup": {
"id": "string",
"isMainItem": "boolean",
"isRequired": "boolean"
},
"campaignKey": "string",
"merchant": {
"referenceKey": "string"
}
}
]
}
}
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"
}
}
}
order-package-shipped
Get notified whenever an order package is shipped.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "order-package-shipped",
"version": "integer",
"payload": {
"order": {
"id": "integer",
"basketKey": "string",
"cost": {
"tax": {
"vat": {
"amount": "integer"
}
},
"withTax": "integer",
"withoutTax": "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",
"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",
"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",
"birthDate": "string",
"email": "string",
"type": "string",
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
}
},
"packages": [
{
"id": "integer",
"carrierKey": "string",
"deliveryStatus": "string",
"deliveryDate": {
"maximum": "string",
"minimum": "string"
},
"shipmentKey": "string",
"tracking": {
"id": "string",
"url": "string"
}
}
],
"shipping": {
"policy": "string"
},
"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",
"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",
"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"
}
}
}
newsletter-subscribed
Get notified when a customer subscribes to a newsletter.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "newsletter-subscribed",
"version": "integer",
"payload": {
"channel": "string",
"customer": {
"id": "integer",
"firstName": "string",
"lastName": "string",
"gender": "string",
"birthDate": "string",
"email": "string",
"phone": "string",
"type": "string",
"groups": [
"string"
],
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
},
"company": {
"id": "integer",
"name": "string"
}
},
"text": "string",
"shopCountry": {
"id": "integer",
"shopKey": "string",
"countryCode": "string",
"defaultLanguageCode": "string",
"supportedLanguageCodes": [],
"priceGroupKey": "object",
"url": "string",
"active": "boolean",
"currencyCode": "string",
"deleted": "boolean"
}
}
}
product-updated
Get notified when:
- Product is created/updated
- Product simple/advanced attribute is created/updated
- Product category is created/updated
- Product Variant is created/updated
- Product Variant simple/advanced attribute is created/updated
- Product Image is created/updated
- Product Image simple attribute is created/updated
Any changes to master level entities won't trigger this event. The ID of the created/updated product is added to a debouncer set, the processor will take the ID out of the debouncer only after a configured timeout which is by default 30 sec, and then a product-updated webhook is triggered.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "product-updated",
"version": "integer",
"payload": {
"id": "integer",
"referenceKey": "string",
"merchantReferenceKeys": [
"string"
],
"name": {
"de_DE": "string"
},
"state": "string",
"isComposite": "boolean",
"master": {
"referenceKey": "string",
"categories": {
"isLocked": "boolean",
"paths": [
[
"string"
]
]
},
"attributes": [
{
"name": "string",
"type": "string",
"value": {
"de_DE": "string"
},
"isLocked": "boolean"
}
]
},
"attributes": [
{
"name": "string",
"type": "string",
"value": {
"de_DE": "string"
},
"isLocked": "boolean"
}
],
"variants": [
{
"id": "integer",
"ean": "string",
"referenceKey": "string",
"merchantReferenceKeys": [
"string"
],
"isComposite": "boolean",
"attributes": [
{
"name": "string",
"type": "string",
"value": {
"de_DE": "string"
},
"isLocked": "boolean"
}
],
"customData": "object",
"relatedVariants": []
}
],
"customData": "object"
}
}
product-master-updated
Get notified when a product master is created, when an attribute or category is added to the existing product master. Any changes to products or variants will not trigger this event. The ID of the updated/created product master is added to a debouncer set, the processor will take the ID out of the debouncer only after a configured timeout which is by default 30 sec, and then a product-master-updated webhook is triggered.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "product-master-updated",
"version": "integer",
"payload": {
"referenceKey": "string",
"categories": {
"isLocked": "boolean",
"paths": [
[
"string"
]
]
},
"attributes": [
{
"name": "string",
"type": "string",
"value": [
{
"de_DE": "string"
}
],
"isLocked": "boolean"
}
]
}
}
product-variant-prices-updated
Get notified when:
- Active Product Variant Price is created/updated/deleted
- Future Merchant Variant Price is created/updated/deleted
Any changes to campaign prices won't trigger this event. The ID of the created/updated product variant is added to a debouncer set, the processor will take the ID out of the debouncer only after a configured timeout which is by default 30 sec, and then a product-variant-prices-updated webhook is triggered.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "product-variant-prices-updated",
"version": "integer",
"payload": {
"productVariant": {
"id": "integer",
"referenceKey": "string"
},
"product": {
"id": "integer",
"referenceKey": "string"
},
"prices": [
{
"key": "string",
"price": "integer",
"oldPrice": "object",
"recommendedRetailPrice": "integer",
"buyingPrice": "object",
"tax": "integer",
"countryCode": "string",
"currencyCode": "string",
"groupKey": "object",
"promotionKey": "object",
"validFrom": "string",
"validTo": "object",
"merchantReferenceKey": "string"
}
],
"merchantReferenceKey": "string"
}
}
product-variant-availability-updated
Get notified when availability of a variant change due to:
- Product state changes
- Out of stock / back to stock
- Blocking/unblocking of variants
- Product updates (e.g. attributes, master categories) affecting the availability
- Product deletion/restoration
- Price updates that may result in activating/deactivating the variant
Assortment (base query) changes are only reflected via full availability calculation (once a day). The ID of the created/updated product variant is added to a debouncer set, the processor will take the ID out of the debouncer only after a configured timeout which is by default 30 sec, and then a product-variant-availability-updated webhook is triggered.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "string",
"version": "integer",
"payload": {
"productVariant": {
"id": "integer",
"referenceKey": "string"
},
"product": {
"id": "integer",
"referenceKey": "string"
},
"availabilities": [
{
"shopCountry": {
"id": "integer",
"shopKey": "string",
"countryCode": "string"
},
"available": "boolean"
}
],
"merchantReferenceKey": "string"
}
}
product-variant-stock-updated
Get notified when the stock of a product variant changes.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "product-variant-stock-updated",
"version": "integer",
"payload": {
"productVariant": {
"id": "integer",
"referenceKey": "string"
},
"product": {
"id": "integer",
"referenceKey": "string"
},
"warehouse": {
"id": "integer",
"referenceKey": "string"
},
"quantity": "integer",
"sellableWithoutStock": "boolean",
"createdAt": "datetime",
"merchantReferenceKey": "string",
"expectedAvailabilityAt": "object"
}
}
shop-category-tree-updated
The webhook only informs about that the shop category tree has changed.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "shop-category-tree-update",
"payload": {
"shop": {
"id": "integer",
"key": "string"
}
}
}
The tree needs to be fetched via the GET /shops/{shopKey}/categories Admin API endpoint.
Get notified when:
- Categories are added/removed
- Categories are moved
- The state (active/visible) of the shop country-specific category changes to shop category
- Custom data on shop category or shop country category changes
- Background jobs that applied category changes are finished (e.g. recalculation of paths)\
Attaching/detaching of products to the categories won't trigger this event. The ID of the affected shop is added to a debouncer set, the processor will take the ID out of the debouncer only after a configured timeout which is by default 60 sec, and then a shop-category-tree-updated webhook is triggered.
payment-capture
This webhook will be triggered for every late capture that occurs within an order.
It is important to note that the webhook is triggered per payment capture and, in case an order has more than one payment type, an individual webhook will be triggered per payment capture.
Within the transaction payload, the operationStatus will provide if the payment capture was successful or not and the transactionID will provide the transaction key that is also better detailed on the payment payload of the webhook.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "payment-capture",
"version": "integer",
"payload": {
"id": "integer",
"basketKey": "string",
"cost": {
"tax": {
"vat": {
"amount": "integer"
}
},
"withTax": "integer",
"withoutTax": "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"
},
"state": "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"
},
"state": "string"
}
},
"contacts": [
{
"type": "string"
}
],
"items": [
{
"packageId": "integer",
"price": {
"withTax": "integer",
"withoutTax": "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",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
},
{
"packageId": "integer",
"price": {
"withTax": "integer",
"withoutTax": "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",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
},
{
"packageId": "integer",
"price": {
"withTax": "integer",
"withoutTax": "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",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
},
{
"packageId": "integer",
"price": {
"withTax": "integer",
"withoutTax": "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",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
}
],
"payment": [
{
"key": "string",
"amount": "integer",
"data": {
"success": "boolean",
"transaction_id": "string"
},
"transactionKey": "string",
"isGiftCard": "boolean"
}
],
"customer": {
"id": "integer",
"firstName": "string",
"lastName": "string",
"gender": "string",
"birthDate": "string",
"email": "string",
"type": "string",
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
}
},
"invoicedAt": "datetime",
"packages": [
{
"id": "integer",
"carrierKey": "string",
"deliveryStatus": "string",
"deliveryDate": {
"maximum": "string",
"minimum": "string"
},
"shipmentKey": "string",
"tracking": {
"id": "string",
"url": "string"
}
}
],
"shipping": {
"policy": "string"
},
"updatedAt": "datetime",
"createdAt": "datetime",
"confirmedAt": "datetime",
"shopCountry": {
"id": "integer",
"shopKey": "string",
"countryCode": "string",
"defaultLanguageCode": "string",
"supportedLanguageCodes": [],
"priceGroupKey": "string",
"url": "string",
"active": "boolean",
"currencyCode": "string",
"deleted": "boolean"
},
"transaction": {
"transactionId": "string",
"operationStatus": "string"
}
}
}
payment-refund
This webhook is triggered every time a refund is triggered.
An individual webhook will be sent for every refund trigger that is done and the operationStatus will provide if the refund payment was successful or not. the transactionID within transaction will provide the transaction key of the payment that is also better detailed on the payment payload of the webhook.
{
"key": "string",
"meta": {
"tenantKey": "string",
"xRequestId": "string"
},
"occurredAt": "datetime",
"type": "payment-refund",
"version": "integer",
"payload": {
"id": "integer",
"basketKey": "string",
"cost": {
"tax": {
"vat": {
"amount": "integer"
}
},
"withTax": "integer",
"withoutTax": "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"
},
"state": "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"
},
"state": "string"
}
},
"contacts": [
{
"type": "string"
}
],
"items": [
{
"packageId": "integer",
"price": {
"withTax": "integer",
"withoutTax": "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",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
},
{
"packageId": "integer",
"price": {
"withTax": "integer",
"withoutTax": "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",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
},
{
"packageId": "integer",
"price": {
"withTax": "integer",
"withoutTax": "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",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
},
{
"packageId": "integer",
"price": {
"withTax": "integer",
"withoutTax": "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",
"itemGroup": "object",
"merchant": {
"referenceKey": "string"
},
"createdAt": "datetime",
"updatedAt": "datetime"
}
],
"payment": [
{
"key": "string",
"amount": "integer",
"data": {
"success": "boolean",
"transaction_id": "string"
},
"transactionKey": "string",
"isGiftCard": "boolean"
}
],
"customer": {
"id": "integer",
"firstName": "string",
"lastName": "string",
"gender": "string",
"birthDate": "string",
"email": "string",
"type": "string",
"createdAt": "datetime",
"updatedAt": "datetime",
"status": {
"isActive": "boolean",
"isGuestCustomer": "boolean"
}
},
"invoicedAt": "datetime",
"packages": [
{
"id": "integer",
"carrierKey": "string",
"deliveryStatus": "string",
"deliveryDate": {
"maximum": "string",
"minimum": "string"
},
"shipmentKey": "string",
"tracking": {
"id": "string",
"url": "string"
}
}
],
"shipping": {
"policy": "string"
},
"updatedAt": "datetime",
"createdAt": "datetime",
"confirmedAt": "datetime",
"shopCountry": {
"id": "integer",
"shopKey": "string",
"countryCode": "string",
"defaultLanguageCode": "string",
"supportedLanguageCodes": [],
"priceGroupKey": "string",
"url": "string",
"active": "boolean",
"currencyCode": "string",
"deleted": "boolean"
},
"transaction": {
"transactionId": "string",
"operationStatus": "string"
}
}
}
