What Shopify Order Data Does Admin Shortcuts Send With Button Clicks?
A reference for the Shopify order data payload Admin Shortcuts sends to your webhook with each button click.
The Admin Shortcuts app sends a webhook every time a button is clicked from one of your admin pages in Shopify. For buttons configured to show up on order detail pages, the app will send the full JSON object for the order, in addition to some extra information about the button and any key-value pairs added in the button configuration.
When testing your webhook, the app will send sample order data from a Shopify test store. When triggering a button from an actual order page in your app, we'll send the actual order data.
Here's what the sample JSON data looks like:
{ "admin_button_context": { "button_id": "13", "button_name": "Send order to #issues channel", "admin_page_type": "Order Details" }, "admin_button_custom_attributes": { "tracking_reason": "issue" }, "admin_button_form_data": {}, "shopify_order": { "id": xxxxxxxxxxx, "admin_graphql_api_id": "gid://shopify/Order/xxxxxxxxxxx", "app_id": 580111, "browser_ip": "168.91.210.236", "buyer_accepts_marketing": false, "cancel_reason": null, "cancelled_at": null, "cart_token": "c1-cbc53a9fe357583acaxxxxxxxxxxx", "checkout_id": xxxxxxxxxxx, "checkout_token": "fdedca56aa4f7afe3xxxxxxxxxxx", "client_details": { "accept_language": "en-US", "browser_height": null, "browser_ip": "xxx.xxx.xxx.xxx", "browser_width": null, "session_hash": null, "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36" }, "closed_at": null, "company": null, "confirmation_number": "xxxxxxxxxxx", "confirmed": true, "contact_email": "xxxxxxxxxxx@xxxxxxxxxxx.com", "created_at": "2024-02-28T22:22:05-05:00", "currency": "USD", "current_subtotal_price": "749.95", "current_subtotal_price_set": { "shop_money": { "amount": "749.95", "currency_code": "USD" }, "presentment_money": { "amount": "749.95", "currency_code": "USD" } }, "current_total_additional_fees_set": null, "current_total_discounts": "0.00", "current_total_discounts_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "current_total_duties_set": null, "current_total_price": "749.95", "current_total_price_set": { "shop_money": { "amount": "749.95", "currency_code": "USD" }, "presentment_money": { "amount": "749.95", "currency_code": "USD" } }, "current_total_tax": "0.00", "current_total_tax_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "customer_locale": "en-US", "device_id": null, "discount_codes": [], "email": "xxxx@xxxxxxxxxx.com", "estimated_taxes": false, "financial_status": "paid", "fulfillment_status": null, "landing_site": "/", "landing_site_ref": null, "location_id": null, "merchant_of_record_app_id": null, "name": "#1001", "note": null, "note_attributes": [], "number": 1, "order_number": 1001, "order_status_url": "https://quickstart-xxxxxxxxxxx.myshopify.com/xxxxxxxxxxx/orders/f66be98f9aecd891ecxxxxxxxxxxx/authenticate?key=xxxxxxxxxxx&none=xxxxxxxxxxx", "original_total_additional_fees_set": null, "original_total_duties_set": null, "payment_gateway_names": [ "bogus" ], "phone": null, "po_number": null, "presentment_currency": "USD", "processed_at": "2024-02-28T22:22:03-05:00", "reference": "32ebcc472f8db7b1c2xxxxxxxxxxx", "referring_site": "", "source_identifier": "32ebcc472f8db7bxxxxxxxxxxx", "source_name": "web", "source_url": null, "subtotal_price": "749.95", "subtotal_price_set": { "shop_money": { "amount": "749.95", "currency_code": "USD" }, "presentment_money": { "amount": "749.95", "currency_code": "USD" } }, "tags": "", "tax_exempt": false, "tax_lines": [], "taxes_included": false, "test": true, "token": "f66be98f9aecd891ec0xxxxxxxxxxx", "total_discounts": "0.00", "total_discounts_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "total_line_items_price": "749.95", "total_line_items_price_set": { "shop_money": { "amount": "749.95", "currency_code": "USD" }, "presentment_money": { "amount": "749.95", "currency_code": "USD" } }, "total_outstanding": "0.00", "total_price": "749.95", "total_price_set": { "shop_money": { "amount": "749.95", "currency_code": "USD" }, "presentment_money": { "amount": "749.95", "currency_code": "USD" } }, "total_shipping_price_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "total_tax": "0.00", "total_tax_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "total_tip_received": "0.00", "total_weight": 0, "updated_at": "2024-02-28T22:22:06-05:00", "user_id": null, "billing_address": { "first_name": "xxxxxxxxxxx", "address1": "xxxx Main Street", "phone": null, "city": "Evanston", "zip": "60201", "province": "Illinois", "country": "United States", "last_name": "xxxxxxxxxxx", "address2": null, "company": null, "latitude": null, "longitude": null, "name": "xxxxxxxxxxx xxxxxxxxxxx", "country_code": "US", "province_code": "IL" }, "customer": { "id": xxxxxxxxxxx, "email": "xxxxxx@xxxxxxxxxxx.com", "created_at": "2024-02-28T22:22:03-05:00", "updated_at": "2024-02-28T22:22:09-05:00", "first_name": "xxxxxx", "last_name": "xxxxxxxxxxx", "state": "disabled", "note": null, "verified_email": true, "multipass_identifier": null, "tax_exempt": false, "phone": null, "email_marketing_consent": { "state": "not_subscribed", "opt_in_level": "single_opt_in", "consent_updated_at": null }, "sms_marketing_consent": null, "tags": "", "currency": "USD", "tax_exemptions": [], "admin_graphql_api_id": "gid://shopify/Customer/xxxxxxxxxxx", "default_address": { "id": xxxxxxxxxxx, "customer_id": xxxxxxxxxxx, "first_name": "xxxxxx", "last_name": "xxxxxxxxx", "company": null, "address1": "xxxx Main Street", "address2": null, "city": "Evanston", "province": "Illinois", "country": "United States", "zip": "6020a", "phone": null, "name": "xxxxxxxxxxx xxxxxxxxxxx", "province_code": "IL", "country_code": "US", "country_name": "United States", "default": true } }, "discount_applications": [], "fulfillments": [], "line_items": [ { "id": xxxxxxxxxxx, "admin_graphql_api_id": "gid://shopify/LineItem/xxxxxxxxxxx", "attributed_staffs": [], "current_quantity": 1, "fulfillable_quantity": 1, "fulfillment_service": "manual", "fulfillment_status": null, "gift_card": false, "grams": 0, "name": "The Collection Snowboard: Liquid", "price": "749.95", "price_set": { "shop_money": { "amount": "749.95", "currency_code": "USD" }, "presentment_money": { "amount": "749.95", "currency_code": "USD" } }, "product_exists": true, "product_id": xxxxxxxxxxx, "properties": [], "quantity": 1, "requires_shipping": true, "sku": "", "taxable": true, "title": "The Collection Snowboard: Liquid", "total_discount": "0.00", "total_discount_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "variant_id": xxxxxxxxxxx, "variant_inventory_management": "shopify", "variant_title": null, "vendor": "Hydrogen Vendor", "tax_lines": [], "duties": [], "discount_allocations": [] } ], "payment_terms": null, "refunds": [], "shipping_address": { "first_name": "xxxxxxxx", "address1": "xxxx Main Street", "phone": null, "city": "Evanston", "zip": "60201", "province": "Illinois", "country": "United States", "last_name": "xxxxxxxxxxx", "address2": null, "company": null, "latitude": xxxxxxxxxxx, "longitude": -xxxxxxxxxxx, "name": "xxxxxxxxxxx xxxxxxxxxxx", "country_code": "US", "province_code": "IL" }, "shipping_lines": [ { "id": xxxxxxxxxxx, "carrier_identifier": "650f1a14fa979ec5c74dxxxxxxxxxxx", "code": "Economy", "discounted_price": "0.00", "discounted_price_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "is_removed": false, "phone": null, "price": "0.00", "price_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "requested_fulfillment_service_id": null, "source": "shopify", "title": "Economy", "tax_lines": [], "discount_allocations": [] } ] }}