Webhook Payloads
NOTIFY_USER​
NOTIFY_USER is raised to trigger a new notification to the user.
Each webhook payload has the notify_event field which defines the type of the notification event and payload.
Customer account has been created​
Expand example
{
"notify_event": "account_confirmation",
"payload": {
"user": {
"id": "VXNlcjo2OA==",
"email": "test@example.com1",
"first_name": "",
"last_name": "",
"is_staff": false,
"is_active": false,
"private_metadata": {},
"metadata": {},
"language_code": "en"
},
"recipient_email": "test@example.com1",
"token": "ajcv09-f3f7880d4a5e33657fe12f9cc372a23f",
"confirm_url": "https://dev.saleor.cloud/account-confirm?email=test%40example.com1&token=ajcv09-f3f7880d4a5e33657fe12f9cc372a23f",
"domain": "example.com",
"site_name": "Saleor e-commerce"
}
}
Expand â–¼
Customer requested a reset password​
Expand example
{
"notify_event": "account_password_reset",
"payload": {
"user": {
"id": "VXNlcjo2OA==",
"email": "test@example.com1",
"first_name": "",
"last_name": "",
"is_staff": false,
"is_active": true,
"private_metadata": {},
"metadata": {},
"language_code": "en"
},
"recipient_email": "test@example.com1",
"token": "ajcvfp-cc31f7d6e10c8553c3fe923876d0451f",
"reset_url": "https://dev.saleor.cloud/reset-password?email=test%40example.com1&token=ajcvfp-cc31f7d6e10c8553c3fe923876d0451f",
"domain": "example.com",
"site_name": "Saleor e-commerce"
}
}
Expand â–¼
Customer requested email change​
Expand example
{
"notify_event": "account_change_email_request",
"payload": {
"user": {
"id": "VXNlcjo2OA==",
"email": "test@example.com1",
"first_name": "",
"last_name": "",
"is_staff": false,
"is_active": false,
"private_metadata": {},
"metadata": {},
"language_code": "en"
},
"old_email": "test@example.com1",
"new_email": "new.email@example.com1",
"recipient_email": "new.email@example.com1",
"token": "ajcv09-f3f7880d4a5e33650fe12f9cc372a23f",
"redirect_url": "https://dev.saleor.cloud/account-change?email=test%40example.com1&token=ajcv09-f3f7880d4a5e33650fe12f9cc372a23f",
"domain": "example.com",
"site_name": "Saleor e-commerce"
}
}
Expand â–¼
Customer confirmed email change​
Expand example
{
"notify_event": "account_change_email_confirm",
"payload": {
"user": {
"id": "VXNlcjo2OA==",
"email": "test@example.com1",
"first_name": "",
"last_name": "",
"is_staff": false,
"is_active": false,
"private_metadata": {},
"metadata": {},
"language_code": "en"
},
"recipient_email": "test@example.com1",
"domain": "example.com",
"site_name": "Saleor e-commerce"
}
}
Expand â–¼
Customer requested a delete account​
Expand example
{
"notify_event": "account_delete",
"payload": {
"user": {
"id": "VXNlcjo2Nw==",
"email": "admin@example.com",
"first_name": "",
"last_name": "",
"is_staff": true,
"is_active": true,
"private_metadata": {},
"metadata": {},
"language_code": "en"
},
"recipient_email": "admin@example.com",
"token": "ajcvzr-47f32f211ae984939a5f7ce6daf928b2",
"delete_url": "https://dev.saleor.cloud/logout?token=ajcvzr-47f32f211ae984939a5f7ce6daf928b2",
"domain": "example.com",
"site_name": "Saleor e-commerce"
}
}
Expand â–¼
Staff user has created a customer account​
Expand example
{
"notify_event": "account_set_customer_password",
"payload": {
"user": {
"id": "VXNlcjo3MQ==",
"email": "new.customer@example.com",
"first_name": "",
"last_name": "",
"is_staff": false,
"is_active": true,
"private_metadata": {},
"metadata": {},
"language_code": "en"
},
"token": "ajcx3t-6b86b0037b3d806728cfa1e2e455dcf1",
"recipient_email": "new.customer@example.com",
"password_set_url": "https://example.com/reset?email=new.customer%40example.com&token=ajcx3t-6b86b0037b3d806728cfa1e2e455dcf1",
"domain": "example.com",
"site_name": "Saleor e-commerce"
}
}
Expand â–¼
The invoice for the order is ready​
Expand example
{
"notify_event": "invoice_ready",
"payload": {
"invoice": {
"id": "VXNlcjox",
"number": "1/03/2021",
"download_url": "https://example.com/media/invoices/invoice-1/03/2021-order-52-5d6f7e71-61b6-4af2-ba56-423d304717ac.pdf",
"order_id": "VXNlcjo1Mg=="
},
"recipient_email": "user@example.com",
"requester_user_id": "VXNlcjo2Nw==",
"domain": "example.com",
"site_name": "Saleor e-commerce"
}
}
The order has been created​
Expand example
{
"notify_event": "order_confirmation",
"payload": {
"order": {
"id": "VXNlcjo1MQ==",
"number": "VXNlcjo1MQ==",
"private_metadata": {},
"metadata": {},
"status": "unconfirmed",
"language_code": "en",
"currency": "USD",
"token": "f7080def-babf-4018-87cb-e701b6ccb93d",
"total_net_amount": "240.82",
"undiscounted_total_net_amount": "240.82",
"total_gross_amount": "240.82",
"undiscounted_total_gross_amount": "240.82",
"display_gross_prices": true,
"channel_slug": "default-channel",
"created": "2021-03-11 16:56:59.121991+00:00",
"shipping_price_net_amount": "91.22",
"shipping_price_gross_amount": "91.22",
"order_details_url": "",
"email": "admin@example.com",
"subtotal_gross_amount": "149.60",
"subtotal_net_amount": "149.60",
"tax_amount": "0.00",
"lines": [
{
"id": "VXNlcjoxMjQ=",
"product": {
"id": "VXNlcjo3Mg==",
"attributes": [
{
"assignment": {
"attribute": {
"slug": "flavor",
"name": "Flavor"
}
},
"values": [
{
"name": "Apple",
"value": "",
"slug": "apple",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "details",
"name": "Details"
}
},
"values": [
{
"name": "Apple juice details",
"value": "",
"slug": "72_2",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "product-type",
"name": "product-type"
}
},
"values": [
{
"name": "ABC",
"value": "",
"slug": "abc",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "related-products",
"name": "Related products"
}
},
"values": []
}
],
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"product_name": "Apple Juice",
"translated_product_name": "Apple Juice",
"variant_name": "1l",
"variant": {
"id": "VXNlcjoyMDM=",
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"translated_variant_name": "1l",
"product_sku": "43226647",
"quantity": 11,
"quantity_fulfilled": 0,
"currency": "USD",
"unit_price_net_amount": "4.00",
"unit_price_gross_amount": "4.00",
"unit_tax_amount": "0.00",
"total_gross_amount": "44.00",
"total_net_amount": "44.00",
"total_tax_amount": "0.00",
"tax_rate": "0.0000",
"is_shipping_required": true,
"is_digital": false,
"digital_url": "",
"unit_discount_value": "0.00",
"unit_discount_reason": null,
"unit_discount_type": "fixed",
"unit_discount_amount": "0.00"
}
],
"billing_address": {
"first_name": "Maciej",
"last_name": "KK",
"company_name": "",
"street_address_1": "Teczowa 7",
"street_address_2": "",
"city": "WROCLAW",
"city_area": "",
"postal_code": "53-601",
"country": "PL",
"country_area": "",
"phone": ""
},
"shipping_address": {
"first_name": "Maciej",
"last_name": "KK",
"company_name": "",
"street_address_1": "Teczowa 7",
"street_address_2": "",
"city": "WROCLAW",
"city_area": "",
"postal_code": "53-601",
"country": "PL",
"country_area": "",
"phone": ""
},
"shipping_method_name": "DB Schenker",
"voucher_discount": null,
"discounts": [],
"discount_amount": 0
},
"recipient_email": "admin@example.com",
"domain": "example.com",
"site_name": "Saleor e-commerce"
}
}
Expand â–¼
The sale has been updated​
Expand example
SALE_CREATED and SALE_DELETED payloads are identical.
{
"notify_event": "sale_updated",
"payload": {
"type": "Sale",
"id": "U2FsZToxMw==",
"categories_added": [],
"categories_removed": [],
"collections_added": ["UHXvJDSjzDoxMjI="],
"collections_removed": [],
"products_added": ["UHJvZHVjdDoxMjI=", "UHJvZHVjdDo3Mg==", "UHJvZHVjdDo3NA==", "UHJvZHVjdDo3OQ=="],
"products_removed": ["UHJvZHVjdFZhcm=="]
"variants_added": [],
"variants_removed": []
}
}
The sale toggle​
Expand example
{
"notify_event": "sale_toggle",
"payload": {
"type": "Sale",
"id": "U2FsZToz",
"categories": ["Q2F0ZWdvcnk6Mjk=", "Q2F0ZWdvcnk6Mjg="],
"collections": [],
"products": [],
"variants": [],
"meta": {
"issued_at": "2022-07-11T08:47:56.192148+00:00",
"version": "3.5.0-a",
"issuing_principal": {
"id": "VXNlcjox",
"type": "user"
}
},
"is_active": false
}
}
Expand â–¼
The order has been confirmed by the staff user​
Expand example
{
"notify_event": "order_confirmed",
"payload": {
"order": {
"id": "VXNlcjo1MQ==",
"number": "VXNlcjo1MQ==",
"private_metadata": {},
"metadata": {},
"status": "unfulfilled",
"language_code": "en",
"currency": "USD",
"token": "f7080def-babf-4018-87cb-e701b6ccb93d",
"total_net_amount": "240.82",
"undiscounted_total_net_amount": "240.82",
"total_gross_amount": "240.82",
"undiscounted_total_gross_amount": "240.82",
"display_gross_prices": true,
"channel_slug": "default-channel",
"created": "2021-03-11 16:56:59.121991+00:00",
"shipping_price_net_amount": "91.22",
"shipping_price_gross_amount": "91.22",
"order_details_url": "",
"email": "admin@example.com",
"subtotal_gross_amount": "149.60",
"subtotal_net_amount": "149.60",
"tax_amount": "0.00",
"lines": [
{
"id": "VXNlcjoxMjQ=",
"product": {
"id": "VXNlcjo3Mg==",
"attributes": [
{
"assignment": {
"attribute": {
"slug": "flavor",
"name": "Flavor"
}
},
"values": [
{
"name": "Apple",
"value": "",
"slug": "apple",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "details",
"name": "Details"
}
},
"values": [
{
"name": "Apple juice details",
"value": "",
"slug": "72_2",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "product-type",
"name": "product-type"
}
},
"values": [
{
"name": "ABC",
"value": "",
"slug": "abc",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "related-products",
"name": "Related products"
}
},
"values": []
}
],
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"product_name": "Apple Juice",
"translated_product_name": "Apple Juice",
"variant_name": "1l",
"variant": {
"id": "VXNlcjoyMDM=",
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"translated_variant_name": "1l",
"product_sku": "43226647",
"quantity": 11,
"quantity_fulfilled": 0,
"currency": "USD",
"unit_price_net_amount": "4.00",
"unit_price_gross_amount": "4.00",
"unit_tax_amount": "0.00",
"total_gross_amount": "44.00",
"total_net_amount": "44.00",
"total_tax_amount": "0.00",
"tax_rate": "0.0000",
"is_shipping_required": true,
"is_digital": false,
"digital_url": "",
"unit_discount_value": "0.00",
"unit_discount_reason": null,
"unit_discount_type": "fixed",
"unit_discount_amount": "0.00"
}
],
"billing_address": {
"first_name": "Maciej",
"last_name": "KK",
"company_name": "",
"street_address_1": "Teczowa 7",
"street_address_2": "",
"city": "WROCLAW",
"city_area": "",
"postal_code": "53-601",
"country": "PL",
"country_area": "",
"phone": ""
},
"shipping_address": {
"first_name": "Maciej",
"last_name": "KK",
"company_name": "",
"street_address_1": "Teczowa 7",
"street_address_2": "",
"city": "WROCLAW",
"city_area": "",
"postal_code": "53-601",
"country": "PL",
"country_area": "",
"phone": ""
},
"shipping_method_name": "DB Schenker",
"voucher_discount": null,
"discounts": [],
"discount_amount": 0
},
"recipient_email": "admin@example.com",
"requester_user_id": "VXNlcjo2Nw==",
"domain": "example.com",
"site_name": "Saleor e-commerce"
}
}
Expand â–¼
The order has been fulfilled​
Expand example
{
"notify_event": "order_fulfillment_confirmation",
"payload": {
"order": {
"id": "VXNlcjo1Mg==",
"number": 52,
"private_metadata": {},
"metadata": {},
"status": "partially fulfilled",
"language_code": "en",
"currency": "USD",
"token": "7b212dfe-c8df-4991-bd4f-f42e5135e04c",
"total_net_amount": "55.18",
"undiscounted_total_net_amount": "55.18",
"total_gross_amount": "55.18",
"undiscounted_total_gross_amount": "55.18",
"display_gross_prices": true,
"channel_slug": "default-channel",
"created": "2021-03-11 16:57:47.697075+00:00",
"shipping_price_net_amount": "33.58",
"shipping_price_gross_amount": "33.58",
"order_details_url": "",
"email": "admin@example.com",
"subtotal_gross_amount": "21.60",
"subtotal_net_amount": "21.60",
"tax_amount": "0.000",
"lines": [
{
"id": "VXNlcjoxMjY=",
"product": {
"id": "VXNlcjo3Mg==",
"attributes": [
{
"assignment": {
"attribute": {
"slug": "flavor",
"name": "Flavor"
}
},
"values": [
{
"name": "Apple",
"value": "",
"slug": "apple",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "details",
"name": "Details"
}
},
"values": [
{
"name": "Apple juice details",
"value": "",
"slug": "72_2",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "product-type",
"name": "product-type"
}
},
"values": [
{
"name": "ABC",
"value": "",
"slug": "abc",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "related-products",
"name": "Related products"
}
},
"values": []
}
],
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"product_name": "Apple Juice",
"translated_product_name": "Apple Juice",
"variant_name": "1l",
"variant": {
"id": "VXNlcjoyMDM=",
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"translated_variant_name": "1l",
"product_sku": "43226647",
"quantity": 2,
"quantity_fulfilled": 1,
"currency": "USD",
"unit_price_net_amount": "4.00",
"unit_price_gross_amount": "4.00",
"unit_tax_amount": "0.00",
"total_gross_amount": "8.00",
"total_net_amount": "8.00",
"total_tax_amount": "0.00",
"tax_rate": "0.0000",
"is_shipping_required": true,
"is_digital": false,
"digital_url": "",
"unit_discount_value": "0.00",
"unit_discount_reason": null,
"unit_discount_type": "fixed",
"unit_discount_amount": "0.00"
}
],
"billing_address": {
"first_name": "Maciej",
"last_name": "KK",
"company_name": "",
"street_address_1": "Teczowa 7",
"street_address_2": "",
"city": "WROCLAW",
"city_area": "",
"postal_code": "53-601",
"country": "PL",
"country_area": "",
"phone": ""
},
"shipping_address": {
"first_name": "Maciej",
"last_name": "KK",
"company_name": "",
"street_address_1": "Teczowa 7",
"street_address_2": "",
"city": "WROCLAW",
"city_area": "",
"postal_code": "53-601",
"country": "PL",
"country_area": "",
"phone": ""
},
"shipping_method_name": "DHL",
"voucher_discount": null,
"discounts": [],
"discount_amount": 0
},
"fulfillment": {
"tracking_number": "",
"is_tracking_number_url": false
},
"physical_lines": [
{
"id": "VXNlcjo1Mg==",
"order_line": {
"id": "VXNlcjoxMjY=",
"product": {
"id": "VXNlcjo3Mg==",
"attributes": [
{
"assignment": {
"attribute": {
"slug": "flavor",
"name": "Flavor"
}
},
"values": [
{
"name": "Apple",
"value": "",
"slug": "apple",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "details",
"name": "Details"
}
},
"values": [
{
"name": "Apple juice details",
"value": "",
"slug": "72_2",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "product-type",
"name": "product-type"
}
},
"values": [
{
"name": "ABC",
"value": "",
"slug": "abc",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "related-products",
"name": "Related products"
}
},
"values": []
}
],
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"product_name": "Apple Juice",
"translated_product_name": "Apple Juice",
"variant_name": "1l",
"variant": {
"id": "VXNlcjoyMDM=",
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"translated_variant_name": "1l",
"product_sku": "43226647",
"quantity": 2,
"quantity_fulfilled": 1,
"currency": "USD",
"unit_price_net_amount": "4.00",
"unit_price_gross_amount": "4.00",
"unit_tax_amount": "0.00",
"total_gross_amount": "8.00",
"total_net_amount": "8.00",
"total_tax_amount": "0.00",
"tax_rate": "0.0000",
"is_shipping_required": true,
"is_digital": false,
"digital_url": "",
"unit_discount_value": "0.00",
"unit_discount_reason": null,
"unit_discount_type": "fixed",
"unit_discount_amount": "0.00"
},
"quantity": 1
}
],
"digital_lines": [],
"recipient_email": "admin@example.com",
"domain": "example.com",
"site_name": "Saleor e-commerce",
"requester_user_id": "VXNlcjo2Nw=="
}
}
Expand â–¼
The fulfillment has been updated​
Expand example
{
"notify_event": "order_fulfillment_update",
"payload": {
"order": {
"id": "VXNlcjo1Mg==",
"number": 52,
"private_metadata": {},
"metadata": {},
"status": "partially fulfilled",
"language_code": "en",
"currency": "USD",
"token": "7b212dfe-c8df-4991-bd4f-f42e5135e04c",
"total_net_amount": "55.18",
"undiscounted_total_net_amount": "55.18",
"total_gross_amount": "55.18",
"undiscounted_total_gross_amount": "55.18",
"display_gross_prices": true,
"channel_slug": "default-channel",
"created": "2021-03-11 16:57:47.697075+00:00",
"shipping_price_net_amount": "33.58",
"shipping_price_gross_amount": "33.58",
"order_details_url": "",
"email": "admin@example.com",
"subtotal_gross_amount": "21.60",
"subtotal_net_amount": "21.60",
"tax_amount": "0.00",
"lines": [
{
"id": "VXNlcjoxMjY=",
"product": {
"id": "VXNlcjo3Mg==",
"attributes": [
{
"assignment": {
"attribute": {
"slug": "flavor",
"name": "Flavor"
}
},
"values": [
{
"name": "Apple",
"value": "",
"slug": "apple",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "details",
"name": "Details"
}
},
"values": [
{
"name": "Apple juice details",
"value": "",
"slug": "72_2",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "product-type",
"name": "product-type"
}
},
"values": [
{
"name": "ABC",
"value": "",
"slug": "abc",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "related-products",
"name": "Related products"
}
},
"values": []
}
],
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"product_name": "Apple Juice",
"translated_product_name": "Apple Juice",
"variant_name": "1l",
"variant": {
"id": "VXNlcjoyMDM=",
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"translated_variant_name": "1l",
"product_sku": "43226647",
"quantity": 2,
"quantity_fulfilled": 1,
"currency": "USD",
"unit_price_net_amount": "4.00",
"unit_price_gross_amount": "4.00",
"unit_tax_amount": "0.00",
"total_gross_amount": "8.00",
"total_net_amount": "8.00",
"total_tax_amount": "0.00",
"tax_rate": "0.0000",
"is_shipping_required": true,
"is_digital": false,
"digital_url": "",
"unit_discount_value": "0.00",
"unit_discount_reason": null,
"unit_discount_type": "fixed",
"unit_discount_amount": "0.00"
}
],
"billing_address": {
"first_name": "Maciej",
"last_name": "KK",
"company_name": "",
"street_address_1": "Teczowa 7",
"street_address_2": "",
"city": "WROCLAW",
"city_area": "",
"postal_code": "53-601",
"country": "PL",
"country_area": "",
"phone": ""
},
"shipping_address": {
"first_name": "Maciej",
"last_name": "KK",
"company_name": "",
"street_address_1": "Teczowa 7",
"street_address_2": "",
"city": "WROCLAW",
"city_area": "",
"postal_code": "53-601",
"country": "PL",
"country_area": "",
"phone": ""
},
"shipping_method_name": "DHL",
"voucher_discount": null,
"discounts": [],
"discount_amount": 0
},
"fulfillment": {
"tracking_number": "http://127.0.0.1:8000/tracking-url",
"is_tracking_number_url": true
},
"physical_lines": [
{
"id": "VXNlcjo1Mg==",
"order_line": {
"id": "VXNlcjoxMjY=",
"product": {
"id": "VXNlcjo3Mg==",
"attributes": [
{
"assignment": {
"attribute": {
"slug": "flavor",
"name": "Flavor"
}
},
"values": [
{
"name": "Apple",
"value": "",
"slug": "apple",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "details",
"name": "Details"
}
},
"values": [
{
"name": "Apple juice details",
"value": "",
"slug": "72_2",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "product-type",
"name": "product-type"
}
},
"values": [
{
"name": "ABC",
"value": "",
"slug": "abc",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "related-products",
"name": "Related products"
}
},
"values": []
}
],
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"product_name": "Apple Juice",
"translated_product_name": "Apple Juice",
"variant_name": "1l",
"variant": {
"id": "VXNlcjoyMDM=",
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"translated_variant_name": "1l",
"product_sku": "43226647",
"quantity": 2,
"quantity_fulfilled": 1,
"currency": "USD",
"unit_price_net_amount": "4.00",
"unit_price_gross_amount": "4.00",
"unit_tax_amount": "0.00",
"total_gross_amount": "8.00",
"total_net_amount": "8.00",
"total_tax_amount": "0.00",
"tax_rate": "0.0000",
"is_shipping_required": true,
"is_digital": false,
"digital_url": "",
"unit_discount_value": "0.00",
"unit_discount_reason": null,
"unit_discount_type": "fixed",
"unit_discount_amount": "0.00"
},
"quantity": 1
}
],
"digital_lines": [],
"recipient_email": "admin@example.com",
"domain": "example.com",
"site_name": "Saleor e-commerce"
}
}
Expand â–¼
The payment has been confirmed​
Expand example
{
"notify_event": "order_payment_confirmation",
"payload": {
"order": {
"id": "VXNlcjo1MQ==",
"number": "VXNlcjo1MQ==",
"private_metadata": {},
"metadata": {},
"status": "unconfirmed",
"language_code": "en",
"currency": "USD",
"token": "f7080def-babf-4018-87cb-e701b6ccb93d",
"total_net_amount": "240.82",
"undiscounted_total_net_amount": "240.82",
"total_gross_amount": "240.82",
"undiscounted_total_gross_amount": "240.82",
"display_gross_prices": true,
"channel_slug": "default-channel",
"created": "2021-03-11 16:56:59.121991+00:00",
"shipping_price_net_amount": "91.22",
"shipping_price_gross_amount": "91.22",
"order_details_url": "",
"email": "admin@example.com",
"subtotal_gross_amount": "149.60",
"subtotal_net_amount": "149.60",
"tax_amount": "0.00",
"lines": [
{
"id": "VXNlcjoxMjM=",
"product": {
"id": "VXNlcjo3Mg==",
"attributes": [
{
"assignment": {
"attribute": {
"slug": "flavor",
"name": "Flavor"
}
},
"values": [
{
"name": "Apple",
"value": "",
"slug": "apple",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "details",
"name": "Details"
}
},
"values": [
{
"name": "Apple juice details",
"value": "",
"slug": "72_2",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "product-type",
"name": "product-type"
}
},
"values": [
{
"name": "ABC",
"value": "",
"slug": "abc",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "related-products",
"name": "Related products"
}
},
"values": []
}
],
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"product_name": "Apple Juice",
"translated_product_name": "Apple Juice",
"variant_name": "500ml",
"variant": {
"id": "VXNlcjoyMDI=",
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"translated_variant_name": "500ml",
"product_sku": "93855755",
"quantity": 11,
"quantity_fulfilled": 0,
"currency": "USD",
"unit_price_net_amount": "4.00",
"unit_price_gross_amount": "4.00",
"unit_tax_amount": "0.00",
"total_gross_amount": "44.00",
"total_net_amount": "44.00",
"total_tax_amount": "0.00",
"tax_rate": "0.0000",
"is_shipping_required": true,
"is_digital": false,
"digital_url": "",
"unit_discount_value": "0.00",
"unit_discount_reason": null,
"unit_discount_type": "fixed",
"unit_discount_amount": "0.00"
}
],
"billing_address": {
"first_name": "Maciej",
"last_name": "KK",
"company_name": "",
"street_address_1": "Teczowa 7",
"street_address_2": "",
"city": "WROCLAW",
"city_area": "",
"postal_code": "53-601",
"country": "PL",
"country_area": "",
"phone": ""
},
"shipping_address": {
"first_name": "Maciej",
"last_name": "KK",
"company_name": "",
"street_address_1": "Teczowa 7",
"street_address_2": "",
"city": "WROCLAW",
"city_area": "",
"postal_code": "53-601",
"country": "PL",
"country_area": "",
"phone": ""
},
"shipping_method_name": "DB Schenker",
"voucher_discount": null,
"discounts": [],
"discount_amount": 0
},
"recipient_email": "admin@example.com",
"payment": {
"created": "2021-03-11T16:56:57.028Z",
"modified": "2021-03-11T16:56:59.100Z",
"charge_status": "fully-charged",
"total": "240.82",
"captured_amount": "240.82",
"currency": "USD"
},
"domain": "example.com",
"site_name": "Saleor e-commerce"
}
}
Expand â–¼
The order has been canceled​
Expand example
{
"notify_event": "order_canceled",
"payload": {
"requester_user_id": "VXNlcjo2Nw==",
"order": {
"id": "VXNlcjo1Mw==",
"number": 53,
"private_metadata": {},
"metadata": {},
"status": "canceled",
"language_code": "en",
"currency": "USD",
"token": "2f330431-fef4-4454-bf93-bdbb831caf3e",
"total_net_amount": "41.68",
"undiscounted_total_net_amount": "41.68",
"total_gross_amount": "41.68",
"undiscounted_total_gross_amount": "41.68",
"display_gross_prices": true,
"channel_slug": "default-channel",
"created": "2021-03-11 16:58:13.461513+00:00",
"shipping_price_net_amount": "33.58",
"shipping_price_gross_amount": "33.58",
"order_details_url": "",
"email": "admin@example.com",
"subtotal_gross_amount": "8.10",
"subtotal_net_amount": "8.10",
"tax_amount": "0.00",
"lines": [
{
"id": "VXNlcjoxMjk=",
"product": {
"id": "VXNlcjo3Mg==",
"attributes": [
{
"assignment": {
"attribute": {
"slug": "flavor",
"name": "Flavor"
}
},
"values": [
{
"name": "Apple",
"value": "",
"slug": "apple",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "details",
"name": "Details"
}
},
"values": [
{
"name": "Apple juice details",
"value": "",
"slug": "72_2",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "product-type",
"name": "product-type"
}
},
"values": [
{
"name": "ABC",
"value": "",
"slug": "abc",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "related-products",
"name": "Related products"
}
},
"values": []
}
],
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"product_name": "Apple Juice",
"translated_product_name": "Apple Juice",
"variant_name": "2l",
"variant": {
"id": "VXNlcjoyMDQ=",
"weight": "2.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"translated_variant_name": "2l",
"product_sku": "80884671",
"quantity": 1,
"quantity_fulfilled": 0,
"currency": "USD",
"unit_price_net_amount": "5.60",
"unit_price_gross_amount": "5.60",
"unit_tax_amount": "0.00",
"total_gross_amount": "5.60",
"total_net_amount": "5.60",
"total_tax_amount": "0.00",
"tax_rate": "0.0000",
"is_shipping_required": true,
"is_digital": false,
"digital_url": "",
"unit_discount_value": "0.000",
"unit_discount_reason": null,
"unit_discount_type": "fixed",
"unit_discount_amount": "0.00"
}
],
"billing_address": {
"first_name": "Maciej",
"last_name": "KK",
"company_name": "",
"street_address_1": "Teczowa 7",
"street_address_2": "",
"city": "WROCLAW",
"city_area": "",
"postal_code": "53-601",
"country": "PL",
"country_area": "",
"phone": ""
},
"shipping_address": {
"first_name": "Maciej",
"last_name": "KK",
"company_name": "",
"street_address_1": "Teczowa 7",
"street_address_2": "",
"city": "WROCLAW",
"city_area": "",
"postal_code": "53-601",
"country": "PL",
"country_area": "",
"phone": ""
},
"shipping_method_name": "DHL",
"voucher_discount": null,
"discounts": [],
"discount_amount": 0
},
"recipient_email": "admin@example.com",
"domain": "example.com",
"site_name": "Saleor e-commerce"
}
}
Expand â–¼
The order has been refunded​
Expand example
{
"notify_event": "order_refund_confirmation",
"payload": {
"requester_user_id": "VXNlcjo2Nw==",
"order": {
"id": "VXNlcjo1MQ==",
"number": "VXNlcjo1MQ==",
"private_metadata": {},
"metadata": {},
"status": "unfulfilled",
"language_code": "en",
"currency": "USD",
"token": "f7080def-babf-4018-87cb-e701b6ccb93d",
"total_net_amount": "240.82",
"undiscounted_total_net_amount": "240.82",
"total_gross_amount": "240.82",
"undiscounted_total_gross_amount": "240.82",
"display_gross_prices": true,
"channel_slug": "default-channel",
"created": "2021-03-11 16:56:59.121991+00:00",
"shipping_price_net_amount": "91.22",
"shipping_price_gross_amount": "91.22",
"order_details_url": "",
"email": "admin@example.com",
"subtotal_gross_amount": "149.60",
"subtotal_net_amount": "149.60",
"tax_amount": "0.00",
"lines": [
{
"id": "VXNlcjoxMjM=",
"product": {
"id": "VXNlcjo3Mg==",
"attributes": [
{
"assignment": {
"attribute": {
"slug": "flavor",
"name": "Flavor"
}
},
"values": [
{
"name": "Apple",
"value": "",
"slug": "apple",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "details",
"name": "Details"
}
},
"values": [
{
"name": "Apple juice details",
"value": "",
"slug": "72_2",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "product-type",
"name": "product-type"
}
},
"values": [
{
"name": "ABC",
"value": "",
"slug": "abc",
"file_url": null
}
]
},
{
"assignment": {
"attribute": {
"slug": "related-products",
"name": "Related products"
}
},
"values": []
}
],
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"product_name": "Apple Juice",
"translated_product_name": "Apple Juice",
"variant_name": "500ml",
"variant": {
"id": "VXNlcjoyMDI=",
"weight": "1.0 kg",
"first_image": {
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
},
"images": [
{
"original": {
"60x60": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-60x60.png",
"540x540": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-540x540.png",
"255x255": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-255x255.png",
"510x510": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-510x510.png",
"120x120": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-120x120.png",
"1080x1080": "https://example.com/media/__sized__/products/saleordemoproduct_fd_juice_06-thumbnail-1080x1080.png"
}
}
]
},
"translated_variant_name": "500ml",
"product_sku": "93855755",
"quantity": 11,
"quantity_fulfilled": 0,
"currency": "USD",
"unit_price_net_amount": "4.00",
"unit_price_gross_amount": "4.00",
"unit_tax_amount": "0.00",
"total_gross_amount": "44.00",
"total_net_amount": "44.00",
"total_tax_amount": "0.00",
"tax_rate": "0.0000",
"is_shipping_required": true,
"is_digital": false,
"digital_url": "",
"unit_discount_value": "0.00",
"unit_discount_reason": null,
"unit_discount_type": "fixed",
"unit_discount_amount": "0.00"
}
],
"billing_address": {
"first_name": "Maciej",
"last_name": "KK",
"company_name": "",
"street_address_1": "Teczowa 7",
"street_address_2": "",
"city": "WROCLAW",
"city_area": "",
"postal_code": "53-601",
"country": "PL",
"country_area": "",
"phone": ""
},
"shipping_address": {
"first_name": "Maciej",
"last_name": "KK",
"company_name": "",
"street_address_1": "Teczowa 7",
"street_address_2": "",
"city": "WROCLAW",
"city_area": "",
"postal_code": "53-601",
"country": "PL",
"country_area": "",
"phone": ""
},
"shipping_method_name": "DB Schenker",
"voucher_discount": null,
"discounts": [],
"discount_amount": 0
},
"recipient_email": "admin@example.com",
"amount": "16.800",
"currency": "USD",
"domain": "example.com",
"site_name": "Saleor e-commerce"
}
}
Expand â–¼
LIST PAYMENT GATEWAYS PAYLOAD​
Expand example
{
"checkout": [
{
"type": "Checkout",
"token": "checkout-uuid-token",
"user": null,
"billing_address": {
"type": "Address",
"id": "QWRkcmVzczo4OQ==",
"first_name": "John",
"last_name": "Doe",
"company_name": "",
"street_address_1": "2000 Main Street",
"street_address_2": "",
"city": "Irvine",
"city_area": "",
"postal_code": "92614",
"country": "US",
"country_area": "CA",
"phone": ""
},
"shipping_address": {
"type": "Address",
"id": "QWRkcmVzczo4Nw==",
"first_name": "John",
"last_name": "Doe",
"company_name": "",
"street_address_1": "2000 Main Street",
"street_address_2": "",
"city": "Irvine",
"city_area": "",
"postal_code": "92614",
"country": "US",
"country_area": "CA",
"phone": ""
},
"shipping_method": null,
"lines": [
{
"sku": "43226647",
"quantity": 1,
"base_price": "5.00",
"currency": "USD",
"full_name": "Apple Juice (1l)",
"product_name": "Apple Juice",
"variant_name": "1l"
}
],
"private_metadata": {},
"metadata": {},
"created": "2021-03-31T12:57:09.605Z",
"last_change": "2021-03-31T12:57:09.643Z",
"email": "john.doe@example.com",
"quantity": 1,
"currency": "USD",
"discount_amount": "0.00",
"discount_name": null
}
],
"currency": "USD"
}
Expand â–¼
PAYMENT ACTIONS​
Expand example
{
"amount": "29.260",
"gateway": "app:1:credit-card",
"currency": "USD",
"billing": {
"first_name": "John",
"last_name": "Doe",
"company_name": "",
"street_address_1": "2000 Main Street",
"street_address_2": "",
"city": "Irvine",
"city_area": "",
"postal_code": "92614",
"country": "US",
"country_area": "CA",
"phone": ""
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"company_name": "",
"street_address_1": "2000 Main Street",
"street_address_2": "",
"city": "Irvine",
"city_area": "",
"postal_code": "92614",
"country": "US",
"country_area": "CA",
"phone": ""
},
"payment_id": "UGF5bWVudDozMw==",
"graphql_payment_id": "UGF5bWVudDozMw==",
"order_id": null,
"customer_ip_address": "127.0.0.1",
"customer_email": "john.doe@example.com",
"token": "FULLY_CHARGED",
"customer_id": null,
"reuse_source": false,
"payment_method": "credit-card",
"data": {}
}
Expand â–¼
PRODUCT VARIANT BACK IN STOCK​
PRODUCT VARIANT BACK IN STOCK is always triggered when a product variant with previously non-available stock
will get a new supply in any warehouse.
Expand example
{
"product_variant_id": "UHJvZHVjdFZhcmlhbnQ6MTk5NA==",
"product_id": "UHJvZHVjdDo0NDY=",
"warehouse_id": "V2FyZWhvdXNlOjEyMw==",
"stock_id": "U3RvY2s6MTIz",
"product_slug": "orange-juice-500-ml"
}
PRODUCT VARIANT OUT OF STOCK​
PRODUCT VARIANT OUT OF STOCK is always triggered when a product variant will have no available stock for any warehouse.
Expand example
{
"product_variant_id": "UHJvZHVjdFZhcmlhbnQ6MTk5NA==",
"product_id": "UHJvZHVjdDo0NDY=",
"warehouse_id": "V2FyZWhvdXNlOjEyMw==",
"stock_id": "U3RvY2s6MTIz",
"product_slug": "orange-juice-500-ml"
}
TRANSACTION ACTION REQUEST​
TRANSACTION_ACTION_REQUEST is called after requesting a change in transaction state (called by a staff user or by an app).
The action object contains all details related to the requested action.
The transaction contains all details related to the TransactionItem object for which the requested action should be called.
Expand example
{
"action": {
"currency": "USD",
"type": "charge",
"value": "5.00"
},
"transaction": {
"authorized_value": "10.00",
"available_actions": ["charge", "void"],
"charged_value": "0.00",
"checkout_id": "None",
"created_at": "1914-06-28T10:50:00Z",
"currency": "USD",
"modified_at": "1914-06-28T10:50:00Z",
"order_id": "T3JkZXI6MWVhZjk5MmItZTNmNy00ZTJmLWJlZDctNjZlYzc0MmE4MGIz",
"reference": "PSP ref",
"refunded_value": "0.00",
"status": "Authorized",
"type": "Credit card",
"voided_value": "0.00"
}
}
Expand â–¼
Was this page helpful?