Get abandoned checkouts

Requires read_orders access scope.
For more info, refer to:
access permission.
GET https://{handle}.myshopline.com/admin/openapi/v20260301/orders/abandoned_orders.json
handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .
Get a list of abandoned checkouts for the store. You can use this interface to query generated abandoned checkouts and archived abandoned checkouts.
Query Parameters
  • since_id string
    The ID of a specific abandoned checkout. Start querying abandoned checkouts from this specified ID.
    Example: 2405747245402807605252
  • sorts string
    Sorting method for abandoned checkouts. Pass a URL-encoded JSON array that includes the following fields:
    • key: sorting field
    • sort_type: sorting type ( ascending asc , descending tec )
  • checkout_tokens string
    The unique credential of the abandoned checkout, with multiple ones separated by commas. A maximum of 100 credentials can be passed.
  • created_at_max string
    Specify the latest creation date and time for abandoned checkouts to query. Abandoned checkouts created on and before this time are returned. Format:ISO 8601 .
    Example: 2024-08-31T02:20:26+08:00
  • updated_at_max string
    Specify the earliest update date and time for abandoned checkouts to query. Abandoned checkouts updated on and before this time are returned. Format:ISO 8601 .
    Example: 2024-08-31T02:20:26+08:00
  • page_info string
    The unique identifier for pagination queries, used to locate a specific page.
    This parameter value is obtained from the link value in the response header of this API after you have queried the pagination information.
    For example, if the link value you obtained is <https://{handle}.myshopline.com/admin/openapi/{version}/orders/abandoned_orders.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" , the value of page_info is eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 .
    For more information on how to use pagination, refer to Paging Mechanism.
  • query_page_link_param string
    DEPRECATED: This field is deprecated from API version 20240601.
  • updated_at_min string
    Specify the earliest update date and time for abandoned checkouts to query. Abandoned checkouts updated on and after this time are returned. Format:ISO 8601 .
    Example: 2024-08-31T02:20:26+08:00
  • limit string
    The maximum number of quried abandoned checkouts.
    Default value: 20
    Value range: 0-100
  • status string
    The status of the abandoned checkout. Valid values are:
    • draft: The customer's contact email or mobile phone number is not filled in on the checkout page.
    • open: The customer's contact email or mobile phone number is filled in on the checkout page, but no order is generated at this time.
    • recovered: The customer's contact email or mobile phone number is filled in on the checkout page, the recall email is sent, and the order is generated.
  • created_at_min string
    Specify the earliest creation date and time for abandoned checkouts to query. Abandoned checkouts created on and after this time are returned. Format:ISO 8601 .
    Example: 2024-08-31T02:20:26+08:00
  • ids string
    The unique identifier of the abandoned checkout, with multiple ones separated by commas. A maximum of 100 IDs can be passed.
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • Authorization string required
    The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Status Codes
For the complete list of codes and messages, see Http status code.
Response Headers
  • link
    The URL link that provides the pagination data. You can obtain page_info from this parameter for subsequent pagination requests.
    This parameter is returned when the requested page has a previous or next page.
    For more information on how to use pagination, refer to Paging Mechanism.
  • traceId
    A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.
Response Body
  • abandoned_ordersobject[]
    A list of abandoned checkouts.
  • abandoned_checkout_url string
    Link to the checkout page associated with the abandoned checkout.
  • billing_addressobject
    The address for sending billing invoices.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
  • city string
    The city in the billing address.
  • company string
    The company name of the billing recipient.
  • country string
    Country or region in the billing address.
  • country_code string
    A two-letter code that follows the ISO 3166-1 standard, used to identify a specific country or region in the billing address.
    Example: US
  • first_name string
    The first name of the billing recipient.
  • last_name string
    The last name of the billing recipient.
  • name string
    The full name of the billing recipient.
  • phone string
    The phone number of the billing recipient.
  • province string
    The state or province in the billing address.
  • province_code string
    The code for the province in the address, which is a system custom code. It is recommended to use standard_province_code.
  • standard_province_code string
    The code for the province in the billing address, which is a two-character ISO 3166-2 international code. It differs from the province_code response parameter, which uses a custom code.
  • zip string
    The postal code information of the billing address.
  • checkout_token string
    The unique credential for the abandoned checkout.
    Example: c2c4a57472e5e0c8a760f2f2f9c5c8b6
  • close_at string
    Abandoned checkout closing time. Format: ISO 8601. The closing process occurs in the following two ways:
    • Automatic closing: The system automatically closes the checkout if the order is not completed within 60 days.
    • Order generation: Closing is triggered when an order is generated through the abandoned checkout.
    Example: 2024-08-31T02:20:26+08:00
  • completed_at string
    The date and time when the order was generated. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • created_at string
    The date and time when the abandoned checkout was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • currency string
    Settlement currency. A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • customerobject
    Customer information for the abandoned checkout.
  • addressesobject
    The customer address of the abandoned checkout.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
  • city string
    The city in the address.
  • country string
    The country or region in the address.
  • country_code string
    A two-letter code that follows the ISO 3166-1 standard, used to identify a specific country or region in the abandoned checkout shipping address.
    Example: US
  • first_name string
    The first name of the customer.
  • last_name string
    The last name of the customer.
  • name string
    The full name of the customer.
  • phone string
    The phone number of the customer.
  • province string
    The state or province of the address.
  • province_code string
    The code for the state or province in the address, which can be a custom code or a two-character ISO 3166-2 international code.
  • zip string
    The postal code information of the address.
  • currency string
    Settlement currency. A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • email string
    Customer's contact email.
  • first_name string
    The first name of the recipient.
  • id string
    The unique identifier of the customer.
  • last_name string
    The last name of the recipient.
  • phone string
    The phone number of the recipient.
  • discount_codesobject[]
    The list of promo code information.
  • amount string
    Discount amount. The amount is rounded to two decimal places and displayed in the currency corresponding to presentment_currency.
  • code string
    Discount code. This parameter is empty if no code is used.
    Example: FKSEFIJESZZZ
  • type string
    The discount type. Valid values are:
    • -1: No discount
    • 1: Amount reduction
    • 2: Discount (percentage off)
    • 3: Free shipping
    • 4: Marked-up item
    • 5: Preferential price for any N items
    • 6: Preferential price for A+B combination
    • 7: Free gift
    • 8: Fixed selling price
    • 9: Lowest-priced item free
    • 11: Discount for Nth item
    • 12: Buy X get Y free
    • 13: Customized
    • 14: Price for multiple items
  • email string
    Buyer's contact email.
  • id string
    The unique identifier for the abandoned checkout.
  • line_itemsobject[]
    Product information.
  • image string
    The URL address that stores the product image.
  • price string
    Product amount. The value is rounded to two decimal places.
  • product_id string
    The unique identifier for the product.
  • quantity integer
    Product quantity.
  • sku string
    Product SKU serial number defined by the system.
    Example: 18051197729580850196772413
  • title string
    Product title.
  • note string
    Customer's notes.
  • note_attributesobject[]
    Additional information from the merchant.
  • name string
    The name of the additional information from the merchant.
  • value string
    The value of the additional information from the merchant.
  • phone string
    The phone number of the buyer.
  • presentment_currency string
    The order transaction currency displayed to buyers. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • recovery_status string
    The recovery status of the abandoned checkout. Valid values are:
    • not_recovered: Indicates that a recall email for the abandoned checkout was sent but did not result in a completed order.
    • recovered: Indicates that an abandoned checkout was successfully converted into a completed order after sending a recall email.
  • shipping_addressobject
    Buyer's shipping address information.
  • address1 string
    The first line of the shipping address. This typically includes information such as the street address or a post office box number.
  • address2 string
    The second line of the shipping address. This typically includes information such as apartment, suite, or unit number.
  • city string
    The city in the shipping address.
  • company string
    Company name of the shipping customer.
  • country string
    Country or region in the shipping address.
  • country_code string
    A two-letter code that follows the ISO 3166-1 standard, used to identify a specific country or region in the shipping address.
    Example: US
  • first_name string
    The first name of the customer.
  • last_name string
    The last name of the customer.
  • name string
    The full name of the customer.
  • phone string
    The phone number of the customer.
  • province string
    The state or province of the customer's shipping address.
  • province_code string
    The code for the state or province in the customer address, which can be a custom code or a two-character ISO 3166-2 international code.
  • standard_province_code string
    The code for the province in the shipping address, which is a two-character ISO 3166-2 international code. It differs from the province_code response parameter, which uses a custom code.
  • zip string
    The postal code information of the customer shipping address.
  • shipping_linesobject[]
    Shipping address information.
  • code string
    The shipping template code. When the value is Local delivery, it indicates local delivery; in other cases, it returns the name of the delivery method.
  • phone string
    The merchant contact phone number for the local delivery location.
  • title string
    Shipping plan name.
  • status string
    The status of the abandoned checkout. Valid values are:
    • draft: The customer's contact email or mobile phone number is not filled in on the checkout page.
    • open: The customer's contact email or mobile phone number is filled in on the checkout page, but no order is generated at this time.
    • recovered: The customer's contact email or mobile phone number is filled in on the checkout page, the recall email is sent, and the order is generated.
  • subtotal_price string
    The item price after discount. The amount value must be rounded to two decimal places. The currency of this amount is specified by the presentment_currency field.
  • total_discounts string
    Total discount amount. The amount value must be rounded to two decimal places. The currency of this amount is specified by the presentment_currency field.
  • total_duties string
    Total tariff. The amount value must be rounded to two decimal places. The currency of this amount is specified by the presentment_currency field.
  • total_line_items_price string
    The total price of all products after discounts. The amount value must be rounded to two decimal places. The currency of this amount is specified by the presentment_currency field.
  • total_price string
    Total discounted order amount, including shipping fees and taxes. The amount value must be rounded to two decimal places. The currency of this amount is specified by the presentment_currency field.
  • total_tax string
    The total tax amount of the order.The amount value must be rounded to two decimal places. The currency of this amount is specified by the presentment_currency field.
  • updated_at string
    The date and time when the abandoned checkout was updated. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • user_id string
    The unique identifier for the buyer.
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— header required
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/orders/abandoned_orders.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Get abandoned checkouts
Response
{
  "abandoned_orders": [
    {
      "abandoned_checkout_url": "www.example.com",
      "applied_discounts": [
        {
          "amount": "6.00",
          "description": "ABC",
          "title": "ABC",
          "value": "10"
        }
      ],
      "billing_address": {
        "address1": "ABC",
        "city": "New York",
        "country": "USA",
        "province": "NY",
        "zip": "10001"
      },
      "checkout_token": "**************89sgf7gq58",
      "close_at": "2023-10-01T10:00:00Z",
      "completed_at": "2023-10-02T14:00:00Z",
      "created_at": "2023-09-30T08:00:00Z",
      "currency": "USD",
      "customer": {
        "email": "*********@example.com",
        "first_name": "John",
        "id": "*****************8756872",
        "last_name": "Doe"
      },
      "discount_codes": [
        {
          "amount": "10.00",
          "code": "**************WDLPSQ"
        }
      ],
      "email": "*********@example.com",
      "id": "***************gf7gq58",
      "line_items": [
        {
          "price": "25.00",
          "product_id": "***************6wh2qfr321",
          "quantity": 2,
          "title": "ABC"
        }
      ],
      "note": "ABC",
      "note_attributes": [
        {
          "name": "ABC",
          "value": "true"
        }
      ],
      "phone": "0013101231234",
      "presentment_currency": "USD",
      "shipping_address": {
        "address1": "ABC",
        "city": "New York",
        "country": "USA",
        "province": "NY",
        "zip": "10002"
      },
      "shipping_lines": [
        {
          "price": "5.00",
          "title": "ABC"
        }
      ],
      "status": "draft",
      "subtotal_price": "50.00",
      "total_discounts": "10.00",
      "total_duties": "2.00",
      "total_line_items_price": "60.00",
      "total_price": "45.00",
      "total_tax": "3.00",
      "updated_at": "2023-10-03T09:00:00Z",
      "user_id": "****************875f12gk89"
    }
  ],
  "link": "www.example.com"
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.