Retrieves a list of abandoned checkouts

请求参数

Path 参数

api_version

string

必需

Query 参数

created_at_max

string

可选

Show checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)

created_at_min

string

可选

Show checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)

limit

string

可选

The maximum number of results to show.

since_id

string

可选

Restrict results to after the specified ID.

status

string

可选

Show only checkouts with a given status.

示例值:

open

updated_at_max

string

可选

Show checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)

updated_at_min

string

可选

Show checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)

返回响应

🟢200Retrieves a list of abandoned checkouts

application/json

Body

checkouts

array[object (Abandoned checkouts) {39}]

可选

abandoned_checkout_url

string

可选

The recovery URL that's sent to a customer so they can recover their checkout.

billing_address

string

可选

The mailing address associated with the payment method. It has the following properties:

address1: The street address of the billing address.
address2: An optional additional field for the street address of the billing address.
city: The city of the billing address.
company: The company of the person associated with the billing address.
country: The name of the country of the billing address.
country_code: The two-letter code (ISO 3166-1 alpha-2 format) for the country of the billing address.
default: Whether this is the default address for the customer.
first_name: The first name of the person associated with the payment method.
last_name: The last name of the person associated with the payment method.
latitude: The latitude of the billing address.
longitude: The longitude of the billing address.
name: The full name of the person associated with the payment method.
phone: The phone number at the billing address.
province: The name of the state or province of the billing address.
province_code: The two-letter abbreviation of the state or province of the billing address.
zip: The zip or postal code of the billing address.

buyer_accepts_marketing

string

可选

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

string

可选

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

string

可选

The ID for the cart that's attached to the checkout.

closed_at

string

可选

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

string

可选

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

string

可选

The date and time (ISO 8601 format) when the checkout was created.

currency

string

只读可选

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

string

可选

The customer details associated with the abandoned checkout. For more information, refer to the Customer resource.

customer_locale

string

可选

The two or three-letter language code, optionally followed by a region modifier.
Example values: en, en-CA.

device_id

string

可选

The ID of the Shopify POS device that created the checkout.

discount_codes

string

可选

Discount codes applied to the checkout. Returns an empty array when no codes are applied.

Each discount code has the following fields:

amount: The amount of the discount in presentment currency.
code: The discount code.
type: The type of discount. Valid values: percentage, shipping, fixed_amount. (default: fixed_amount)

示例值:

{"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"}}

string

可选

The customer's email address.

gateway

string

可选

The payment gateway used by the checkout. For abandoned checkouts, this value is always null.

string

可选

The ID for the checkout.

landing_site

string

可选

The URL for the page where the customer entered the shop.

line_items

string

可选

A list of line items, each containing information about an item in the checkout. Each object has the following properties:

fulfillment_service: The fulfillment service provider for the item.
fulfillment_status: The status of the item's fulfillment. Valid values: fulfilled, null, partial.
grams: The weight of the item in grams.
price: The price of the item in presentment currency.
product_id: The product ID od the item.
quantity: The number of products that were purchased.
requires_shipping: Whether the items requires shipping..
sku: A unique identifier for the item in the shop.
title: The title of the product.
variant_id: The product variant ID of item.
variant_title: The title of the product variant.
vendor: The name of the item's supplier.

location_id

string

可选

The ID of the physical location where the checkout was processed.

note

string

可选

The text of an optional note that a shop owner can attach to the order.

phone

string

可选

The customer's phone number for receiving SMS notifications.

presentment_currency

string

可选

The three-letter code (ISO 4217 format) of the currency that the customer used at checkout. For the shop's default currency, see currency.

referring_site

string

可选

The website that referred the customer to the shop.

shipping_address

string

可选

The mailing address where the order will be shipped to. It has the following properties:

address1: The street address of the shipping address.
address2: An optional additional field for the street address of the shipping address.
city: The city of the shipping address.
company: The company of the person associated with the shipping address.
country: The name of the country of the shipping address.
country_code: The two-letter code (ISO 3166-1 alpha-2 format) for the country of the shipping address.
first_name: The first name of the person associated with the shipping address.
last_name: The last name of the person associated with the shipping address.
latitude: The latitude of the shipping address.
longitude: The longitude of the shipping address.
name: The full name of the person associated with the shipping address.
phone: The phone number at the shipping address.
province: The name of the state or province of the shipping address.
province_code: The two-letter abbreviation of the state or province of the shipping address.
zip: The zip or postal code of the shipping address.

sms_marketing_phone

string

可选

The phone number used to opt in to SMS marketing during checkout.

shipping_lines

string

可选

Information about the chosen shipping method. It has the following properties:

code: A reference to the shipping method.
price: The price of the shipping method in presentment currency.
source: The channel where the checkout originated. Example value: shopify.
title: The title of the shipping method. Example value: International Shipping.

source_name

string

可选

Where the checkout originated. Valid values: web, pos, iphone, android.

subtotal_price

string

可选

The price of the checkout in presentment currency before shipping and taxes.

tax_lines

string

可选

An array of tax line objects, each of which details a tax applicable to the checkout. Each object has the following properties:

price: The amount of tax to be charged in presentment currency.
rate: The rate of tax to be applied.
title: The name of the tax.
channel_liable: Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for the tax line.

taxes_included

string

可选

Whether taxes are included in the price.

token

string

可选

A unique ID for a checkout.

total_discounts

string

可选

The total amount of discounts to be applied in presentment currency.

total_duties

string

只读可选

The total duties of the checkout in presentment currency.

total_line_items_price

string

可选

The sum of the prices of all line items in the checkout in presentment currency.

total_price

string

可选

The sum of line item prices, all discounts, shipping costs, and taxes for the checkout in presentment currency.

total_tax

string

可选

The sum of all the taxes applied to the checkout in presentment currency.

total_weight

string

可选

The sum of all the weights in grams of the line items in the checkout.

updated_at

string

可选

The date and time (ISO 8601 format) when the checkout was last modified.

user_id

string

可选

The ID of the user who created the checkout.

示例

Retrieve a limited number of abandoned checkoutsRetrieve all abandoned checkoutsRetrieve checkouts created before date specifiedRetrieve closed abandoned checkouts

{
  "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": [
        {
          "title": "Free Shipping",
          "price": "0.00",
          "code": "Free Shipping",
          "source": "shopify",
          "applied_discounts": [],
          "id": "5da41c1738454765"
        }
      ],
      "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": null,
              "created_at": null,
              "application_type": "discount_code"
            }
          ],
          "key": "28a7cdfa0b96243e",
          "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": null,
              "created_at": null,
              "application_type": "discount_code"
            }
          ],
          "key": "5e12f3305d99c598",
          "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,
      "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",
        "accepts_marketing": false,
        "created_at": "2023-01-03T12:56:35-05:00",
        "updated_at": "2023-01-03T12:56:35-05: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": "",
        "last_order_name": "#1001",
        "currency": "USD",
        "phone": "+16136120707",
        "accepts_marketing_updated_at": "2005-06-12T11:57:11-04:00",
        "marketing_opt_in_level": null,
        "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": "2023-01-03T12:56:35-05: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
        }
      }
    }
  ]
}

Retrieves a list of abandoned checkouts

请求参数

示例代码

返回响应