The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Anchor to section titled 'undefined'

Abandoned checkouts

Requires orders access scope.
Requires access to protected customer data.

You can use the Abandoned checkouts resource to retrieve a list and a count of abandoned checkouts. A checkout is considered abandoned after the customer has added contact information, but before the customer has completed their purchase.

This resource may be helpful to complete the following actions:

  • Gather marketing information on customers who have abandoned their cart.
  • Use information to remarket to abandoned checkout customers.
  • Understand customers’ behavior.
  • Track abandoned checkouts over time.
  • View abandoned checkout items.
Was this section helpful?
Anchor to section titled 'The Abandoned checkouts resource'

The Abandoned checkouts resource

Properties
abandoned_checkout_url
->abandonedCheckoutUrl
The recovery URL that's sent to a customer so they can recover their checkout.
billing_address
Learn more about accessing protected customer data
->billingAddress
The mailing address associated with the payment method. It has the following properties:
buyer_accepts_marketing
->emailMarketingConsent
Whether the customer would like to receive email updates from the shop. This is set by the I want to receive occasional emails about new products, promotions and other news checkbox during checkout.
buyer_accepts_sms_marketing
->smsMarketingConsent
Whether the customer would like to receive SMS updates from the shop. This is set by the Text me with news and offers checkbox during checkout.
cart_token
deprecated
The ID for the cart that's attached to the checkout.
closed_at
deprecated
The date and time (ISO 8601 format) when the checkout was closed. If the checkout was not closed, then this value is null.
completed_at
->completedAt
The date and time (ISO 8601 format) when the checkout was completed. For abandoned checkouts, this value is null until a customer completes the checkout using the recovery URL.
created_at
->createdAt
The date and time (ISO 8601 format) when the checkout was created.
currency
deprecated
The three-letter code (ISO 4217 format) of the shop's default currency at the time of checkout. For the currency that the customer used at checkout, see presentment_currency.
customer
Learn more about accessing protected customer data
->customer
The customer details associated with the abandoned checkout. For more information, refer to the Customer resource.
customer_locale
->locale
The two or three-letter language code, optionally followed by a region modifier. Example values: en, en-CA.
device_id
deprecated
The ID of the Shopify POS device that created the checkout. This field is deprecated.
Was this section helpful?
{}The Abandoned checkouts resource
{
  "abandoned_checkout_url": "https://www.snowdevil.ca/14168/checkouts/0123456789abcdef0456456789abcdef/recover?key=6dacd6065bb80268bda857ee",
  "billing_address": {
    "address1": "Chestnut Street 92",
    "address2": "",
    "city": "Louisville",
    "company": null,
    "country": "United States",
    "country_code": "US",
    "default": true,
    "first_name": "Greg",
    "id": 207119551,
    "last_name": "Piotrowski",
    "name": "Greg Piotrowski",
    "phone": "555-625-1199",
    "province": "Kentucky",
    "province_code": "KY",
    "zip": "40202"
  },
  "buyer_accepts_marketing": false,
  "buyer_accepts_sms_marketing": false,
  "cart_token": "0123456789abcdef0456456789abcdef",
  "closed_at": null,
  "completed_at": null,
  "created_at": "2008-01-10T11:00:00-05:00",
  "currency": {
    "currency": "USD"
  },
  "customer": {
    "accepts_marketing": false,
    "created_at": "2012-03-13T16:09:55-04:00",
    "email": "bob.norman@mail.example.com",
    "first_name": "Bob",
    "id": 207119551,
    "last_name": "Norman",
    "note": null,
    "orders_count": "0",
    "state": null,
    "total_spent": "0.00",
    "updated_at": "2012-03-13T16:09:55-04:00",
    "tags": "tagcity"
  },
  "customer_locale": "fr",
  "device_id": 1,
  "discount_codes": [
    {
      "discount_code": {
        "id": 507328175,
        "code": "WINTERSALE20OFF",
        "usage_count": 0,
        "created_at": "2017-09-25T19:32:28-04:00",
        "updated_at": "2017-09-25T19:32:28-04:00"
      }
    }
  ],
  "email": "bob.norman@mail.example.com",
  "gateway": "authorize_net",
  "id": 450789469,
  "landing_site": "http://www.example.com?source=abc",
  "line_items": {
    "price": 214,
    "product_id": 431300801,
    "quantity": 4,
    "sku": "SKU123",
    "title": "Jib",
    "variant_id": 233402193,
    "variant_title": "Green",
    "vendor": "Ottawa Sail Shop"
  },
  "location_id": 1,
  "note": null,
  "phone": {
    "phone": "+13125551212"
  },
  "presentment_currency": {
    "presentment_currency": "USD"
  },
  "referring_site": "http://www.anexample.com",
  "shipping_address": {
    "address1": "Chestnut Street 92",
    "address2": "Apt 2",
    "city": "Louisville",
    "company": null,
    "country": "United States",
    "first_name": "Bob",
    "last_name": "Norman",
    "latitude": "45.41634",
    "longitude": "-75.6868",
    "phone": "555-625-1199",
    "province": "Kentucky",
    "zip": "40202",
    "name": "Bob Norman",
    "country_code": "US",
    "province_code": "KY"
  },
  "sms_marketing_phone": "+16135555555",
  "shipping_lines": {
    "code": "Free Shipping",
    "price": "0.00",
    "source": "shopify",
    "title": "Free Shipping"
  },
  "source_name": "web",
  "subtotal_price": "398.00",
  "tax_lines": {
    "price": "11.94",
    "rate": 0.06,
    "title": "State Tax",
    "channel_liable": true
  },
  "taxes_included": false,
  "token": "b1946ac92492d2347c6235b4d2611184",
  "total_discounts": "0.00",
  "total_duties": "105.31",
  "total_line_items_price": "398.00",
  "total_price": "409.94",
  "total_tax": "11.94",
  "total_weight": 400,
  "updated_at": "2012-08-24T14:02:15-04:00",
  "user_id": 1
}
Anchor to section titled 'GET request, Retrieves a count of checkouts'

get
Retrieves a count of checkouts

abandonedCheckoutsCount
Retrieves a count of checkouts from the past 90 days
Anchor to section titled 'Parameters of Retrieves a count of checkouts'

Parameters

api_version
string
required
created_at_max
Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)
created_at_min
Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)
since_id
Restrict results to after the specified ID.
status
default open
Count checkouts with a given status.
updated_at_max
Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)
updated_at_min
Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)
Was this section helpful?
Anchor to section titled 'Examples of Retrieves a count of checkouts'

Examples

Query parameters
createdatmax=2013-10-12T07:05:27-02:00
Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)
Was this section helpful?
get
/admin/api/2024-07/checkouts.json?createdatmax=2013-10-12T07:05:27-02:00
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-07/checkouts.json?created_at_max=2013-10-12T07%3A05%3A27-02%3A00" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "checkouts": [
    {
      "id": 450789469,
      "token": "2a1ace52255252df566af0faaedfbfa7",
      "cart_token": "68778783ad298f1c80c3bafcddeea02f",
      "email": "bob.norman@mail.example.com",
      "gateway": null,
      "buyer_accepts_marketing": false,
      "created_at": "2012-10-12T07:05:27-04:00",
      "updated_at": "2012-10-12T07:05:27-04:00",
      "landing_site": null,
      "note": null,
      "note_attributes": [
        {
          "name": "custom engraving",
          "value": "Happy Birthday"
        },
        {
          "name": "colour",
          "value": "green"
        }
      ],
      "referring_site": null,
      "shipping_lines": [
        {
          "code": "Free Shipping",
          "price": "0.00",
          "original_shop_price": null,
          "original_rate_price": null,
          "original_shop_markup": null,
          "source": "shopify",
          "title": "Free Shipping",
          "presentment_title": null,
          "phone": null,
          "tax_lines": null,
          "custom_tax_lines": null,
          "markup": null,
          "delivery_category": null,
          "carrier_identifier": null,
          "carrier_service_id": null,
          "api_client_id": null,
          "requested_fulfillment_service_id": null,
          "applied_discounts": [],
          "delivery_option_group_type": null,
          "delivery_expectation_range": null,
          "delivery_expectation_type": null,
          "estimated_delivery_time_range": null,
          "id": "5da41c1738454765",
          "validation_context": null
        }
      ],
      "taxes_included": false,
      "total_weight": 400,
      "currency": "USD",
      "completed_at": null,
      "closed_at": null,
      "user_id": null,
      "location_id": null,
      "source_identifier": null,
      "source_url": null,
      "device_id": null,
      "phone": null,
      "customer_locale": "en",
      "line_items": [
        {
          "applied_discounts": [],
          "discount_allocations": [
            {
              "id": null,
              "amount": "19.90",
              "description": "TENOFF",
              "created_at": null,
              "application_type": "discount_code",
              "discount_class": "ORDER"
            }
          ],
          "key": "f32827a8d00b0a8d",
          "destination_location_id": null,
          "fulfillment_service": "manual",
          "gift_card": false,
          "grams": 200,
          "origin_location_id": null,
          "presentment_title": "IPod Nano - 8GB",
          "presentment_variant_title": "Red",
          "product_id": 632910392,
          "properties": null,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008RED",
          "tax_lines": [],
          "taxable": true,
          "title": "IPod Nano - 8GB",
          "variant_id": 49148385,
          "variant_title": "Red",
          "variant_price": null,
          "vendor": "Apple",
          "user_id": null,
          "unit_price_measurement": null,
          "rank": null,
          "compare_at_price": null,
          "line_price": "199.00",
          "price": "199.00"
        },
        {
          "applied_discounts": [],
          "discount_allocations": [
            {
              "id": null,
              "amount": "19.90",
              "description": "TENOFF",
              "created_at": null,
              "application_type": "discount_code",
              "discount_class": "ORDER"
            }
          ],
          "key": "7e8c529027b9a00e",
          "destination_location_id": null,
          "fulfillment_service": "manual",
          "gift_card": false,
          "grams": 200,
          "origin_location_id": null,
          "presentment_title": "IPod Nano - 8GB",
          "presentment_variant_title": "Pink",
          "product_id": 632910392,
          "properties": null,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008PINK",
          "tax_lines": [],
          "taxable": true,
          "title": "IPod Nano - 8GB",
          "variant_id": 808950810,
          "variant_title": "Pink",
          "variant_price": null,
          "vendor": "Apple",
          "user_id": null,
          "unit_price_measurement": null,
          "rank": null,
          "compare_at_price": null,
          "line_price": "199.00",
          "price": "199.00"
        }
      ],
      "name": "#450789469",
      "source": null,
      "abandoned_checkout_url": "https://checkout.local/548380009/checkouts/2a1ace52255252df566af0faaedfbfa7/recover",
      "discount_codes": [
        {
          "code": "TENOFF",
          "amount": "39.80",
          "type": "percentage"
        }
      ],
      "tax_lines": [
        {
          "price": "21.49",
          "rate": 0.06,
          "title": "State Tax",
          "channel_liable": null
        }
      ],
      "source_name": "web",
      "presentment_currency": "USD",
      "buyer_accepts_sms_marketing": false,
      "sms_marketing_phone": null,
      "total_discounts": "39.80",
      "total_line_items_price": "398.00",
      "total_price": "379.69",
      "total_tax": "21.49",
      "subtotal_price": "358.20",
      "total_duties": null,
      "reservation_token": "0123456789abcdef0123456789zjkw",
      "billing_address": {
        "first_name": "Bob",
        "address1": "Chestnut Street 92",
        "phone": "+1(502)-459-2181",
        "city": "Louisville",
        "zip": "40202",
        "province": "Kentucky",
        "country": "United States",
        "last_name": "Norman",
        "address2": "",
        "company": null,
        "latitude": 45.41634,
        "longitude": -75.6868,
        "name": "Bob Norman",
        "country_code": "US",
        "province_code": "KY"
      },
      "shipping_address": {
        "first_name": "Bob",
        "address1": "Chestnut Street 92",
        "phone": "+1(502)-459-2181",
        "city": "Louisville",
        "zip": "40202",
        "province": "Kentucky",
        "country": "United States",
        "last_name": "Norman",
        "address2": "",
        "company": null,
        "latitude": 45.41634,
        "longitude": -75.6868,
        "name": "Bob Norman",
        "country_code": "US",
        "province_code": "KY"
      },
      "customer": {
        "id": 207119551,
        "email": "bob.norman@mail.example.com",
        "created_at": "2024-09-26T15:08:21-04:00",
        "updated_at": "2024-09-26T15:08:21-04:00",
        "first_name": "Bob",
        "last_name": "Norman",
        "orders_count": 1,
        "state": "disabled",
        "total_spent": "199.65",
        "last_order_id": 450789469,
        "note": null,
        "verified_email": true,
        "multipass_identifier": null,
        "tax_exempt": false,
        "tags": "Léon, Noël",
        "last_order_name": "#1001",
        "currency": "USD",
        "phone": "+16136120707",
        "tax_exemptions": [],
        "email_marketing_consent": {
          "state": "not_subscribed",
          "opt_in_level": null,
          "consent_updated_at": "2004-06-13T11:57:11-04:00"
        },
        "sms_marketing_consent": {
          "state": "not_subscribed",
          "opt_in_level": "single_opt_in",
          "consent_updated_at": "2024-09-26T15:08:21-04:00",
          "consent_collected_from": "OTHER"
        },
        "admin_graphql_api_id": "gid://shopify/Customer/207119551",
        "default_address": {
          "id": 207119551,
          "customer_id": 207119551,
          "first_name": null,
          "last_name": null,
          "company": null,
          "address1": "Chestnut Street 92",
          "address2": "",
          "city": "Louisville",
          "province": "Kentucky",
          "country": "United States",
          "zip": "40202",
          "phone": "555-625-1199",
          "name": "",
          "province_code": "KY",
          "country_code": "US",
          "country_name": "United States",
          "default": true
        }
      }
    }
  ]
}
Anchor to section titled 'GET request, Retrieves a list of abandoned checkouts'

get
Retrieves a list of abandoned checkouts

abandonedCheckouts
Retrieves a list of abandoned checkouts.
Anchor to section titled 'Parameters of Retrieves a list of abandoned checkouts'

Parameters

api_version
string
required
created_at_max
Show checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)
created_at_min
Show checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)
limit
≤ 250
default 50
The maximum number of results to show.
since_id
Restrict results to after the specified ID.
status
default open
Show only checkouts with a given status.
updated_at_max
Show checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)
updated_at_min
Show checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)
Was this section helpful?
Anchor to section titled 'Examples of Retrieves a list of abandoned checkouts'

Examples

Query parameters
limit=1
≤ 250
default 50
The maximum number of results to show.
Was this section helpful?
get
/admin/api/2024-07/checkouts.json?limit=1
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-07/checkouts.json?limit=1" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "checkouts": [
    {
      "id": 450789469,
      "token": "2a1ace52255252df566af0faaedfbfa7",
      "cart_token": "68778783ad298f1c80c3bafcddeea02f",
      "email": "bob.norman@mail.example.com",
      "gateway": null,
      "buyer_accepts_marketing": false,
      "created_at": "2012-10-12T07:05:27-04:00",
      "updated_at": "2012-10-12T07:05:27-04:00",
      "landing_site": null,
      "note": null,
      "note_attributes": [
        {
          "name": "custom engraving",
          "value": "Happy Birthday"
        },
        {
          "name": "colour",
          "value": "green"
        }
      ],
      "referring_site": null,
      "shipping_lines": [
        {
          "code": "Free Shipping",
          "price": "0.00",
          "original_shop_price": null,
          "original_rate_price": null,
          "original_shop_markup": null,
          "source": "shopify",
          "title": "Free Shipping",
          "presentment_title": null,
          "phone": null,
          "tax_lines": null,
          "custom_tax_lines": null,
          "markup": null,
          "delivery_category": null,
          "carrier_identifier": null,
          "carrier_service_id": null,
          "api_client_id": null,
          "requested_fulfillment_service_id": null,
          "applied_discounts": [],
          "delivery_option_group_type": null,
          "delivery_expectation_range": null,
          "delivery_expectation_type": null,
          "estimated_delivery_time_range": null,
          "id": "5da41c1738454765",
          "validation_context": null
        }
      ],
      "taxes_included": false,
      "total_weight": 400,
      "currency": "USD",
      "completed_at": null,
      "closed_at": null,
      "user_id": null,
      "location_id": null,
      "source_identifier": null,
      "source_url": null,
      "device_id": null,
      "phone": null,
      "customer_locale": "en",
      "line_items": [
        {
          "applied_discounts": [],
          "discount_allocations": [
            {
              "id": null,
              "amount": "19.90",
              "description": "TENOFF",
              "created_at": null,
              "application_type": "discount_code",
              "discount_class": "ORDER"
            }
          ],
          "key": "f32827a8d00b0a8d",
          "destination_location_id": null,
          "fulfillment_service": "manual",
          "gift_card": false,
          "grams": 200,
          "origin_location_id": null,
          "presentment_title": "IPod Nano - 8GB",
          "presentment_variant_title": "Red",
          "product_id": 632910392,
          "properties": null,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008RED",
          "tax_lines": [],
          "taxable": true,
          "title": "IPod Nano - 8GB",
          "variant_id": 49148385,
          "variant_title": "Red",
          "variant_price": null,
          "vendor": "Apple",
          "user_id": null,
          "unit_price_measurement": null,
          "rank": null,
          "compare_at_price": null,
          "line_price": "199.00",
          "price": "199.00"
        },
        {
          "applied_discounts": [],
          "discount_allocations": [
            {
              "id": null,
              "amount": "19.90",
              "description": "TENOFF",
              "created_at": null,
              "application_type": "discount_code",
              "discount_class": "ORDER"
            }
          ],
          "key": "7e8c529027b9a00e",
          "destination_location_id": null,
          "fulfillment_service": "manual",
          "gift_card": false,
          "grams": 200,
          "origin_location_id": null,
          "presentment_title": "IPod Nano - 8GB",
          "presentment_variant_title": "Pink",
          "product_id": 632910392,
          "properties": null,
          "quantity": 1,
          "requires_shipping": true,
          "sku": "IPOD2008PINK",
          "tax_lines": [],
          "taxable": true,
          "title": "IPod Nano - 8GB",
          "variant_id": 808950810,
          "variant_title": "Pink",
          "variant_price": null,
          "vendor": "Apple",
          "user_id": null,
          "unit_price_measurement": null,
          "rank": null,
          "compare_at_price": null,
          "line_price": "199.00",
          "price": "199.00"
        }
      ],
      "name": "#450789469",
      "source": null,
      "abandoned_checkout_url": "https://checkout.local/548380009/checkouts/2a1ace52255252df566af0faaedfbfa7/recover",
      "discount_codes": [
        {
          "code": "TENOFF",
          "amount": "39.80",
          "type": "percentage"
        }
      ],
      "tax_lines": [
        {
          "price": "21.49",
          "rate": 0.06,
          "title": "State Tax",
          "channel_liable": null
        }
      ],
      "source_name": "web",
      "presentment_currency": "USD",
      "buyer_accepts_sms_marketing": false,
      "sms_marketing_phone": null,
      "total_discounts": "39.80",
      "total_line_items_price": "398.00",
      "total_price": "379.69",
      "total_tax": "21.49",
      "subtotal_price": "358.20",
      "total_duties": null,
      "reservation_token": "0123456789abcdef0123456789zjkw",
      "billing_address": {
        "first_name": "Bob",
        "address1": "Chestnut Street 92",
        "phone": "+1(502)-459-2181",
        "city": "Louisville",
        "zip": "40202",
        "province": "Kentucky",
        "country": "United States",
        "last_name": "Norman",
        "address2": "",
        "company": null,
        "latitude": 45.41634,
        "longitude": -75.6868,
        "name": "Bob Norman",
        "country_code": "US",
        "province_code": "KY"
      },
      "shipping_address": {
        "first_name": "Bob",
        "address1": "Chestnut Street 92",
        "phone": "+1(502)-459-2181",
        "city": "Louisville",
        "zip": "40202",
        "province": "Kentucky",
        "country": "United States",
        "last_name": "Norman",
        "address2": "",
        "company": null,
        "latitude": 45.41634,
        "longitude": -75.6868,
        "name": "Bob Norman",
        "country_code": "US",
        "province_code": "KY"
      },
      "customer": {
        "id": 207119551,
        "email": "bob.norman@mail.example.com",
        "created_at": "2024-09-26T15:08:21-04:00",
        "updated_at": "2024-09-26T15:08:21-04:00",
        "first_name": "Bob",
        "last_name": "Norman",
        "orders_count": 1,
        "state": "disabled",
        "total_spent": "199.65",
        "last_order_id": 450789469,
        "note": null,
        "verified_email": true,
        "multipass_identifier": null,
        "tax_exempt": false,
        "tags": "Léon, Noël",
        "last_order_name": "#1001",
        "currency": "USD",
        "phone": "+16136120707",
        "tax_exemptions": [],
        "email_marketing_consent": {
          "state": "not_subscribed",
          "opt_in_level": null,
          "consent_updated_at": "2004-06-13T11:57:11-04:00"
        },
        "sms_marketing_consent": {
          "state": "not_subscribed",
          "opt_in_level": "single_opt_in",
          "consent_updated_at": "2024-09-26T15:08:21-04:00",
          "consent_collected_from": "OTHER"
        },
        "admin_graphql_api_id": "gid://shopify/Customer/207119551",
        "default_address": {
          "id": 207119551,
          "customer_id": 207119551,
          "first_name": null,
          "last_name": null,
          "company": null,
          "address1": "Chestnut Street 92",
          "address2": "",
          "city": "Louisville",
          "province": "Kentucky",
          "country": "United States",
          "zip": "40202",
          "phone": "555-625-1199",
          "name": "",
          "province_code": "KY",
          "country_code": "US",
          "country_name": "United States",
          "default": true
        }
      }
    }
  ]
}