--- title: "Retrieve a list of abandoned checkouts" method: GET path: "/admin/checkouts.json" tags: ["Abandoned Checkout"] --- # Retrieve a list of abandoned checkouts `GET /admin/checkouts.json` Retrieve a list of abandoned checkouts ## Query parameters - `page` number - `limit` number - `email_statuses` string - `sms_statuses` string - `recovery_statuses` string - `search` string ## Response `200` OK - AbandonedCheckoutsSwaggerResponse - `checkouts` AbandonedCheckoutDto[] - `abandoned_at` string - `abandoned_checkout_url` string — Checkout recovery link - `abandoned_email_status` string — Email status of this checkout - `abandoned_sms_status` string — Sms status of this checkout - `billing_address` CustomerAddressDetail - `address1` string — The customer's mailing address. - `address2` string — An additional field for the customer's mailing address. - `city` string — The customer's city, town, or village. - `company` string — The customer's company. - `country` string — The customer's country. - `country_code` string — The two-letter country code corresponding to the customer's country. - `country_id` integer — A unique identifier for the customer. - `country_name` string — The customer's normalized country name. - `cpf_number` string — Brazil CPF Number - `cpf_or_cnpj_number` string — CPF/CNPJ number - `created_at` string, date-time — Created at time - `default` boolean — Whether this address is the default address for the customer. - `first_name` string — The customer's first name. - `id` integer — A unique identifier for the address. - `last_name` string — The customer's last name. - `latitude` number — Latitude - `longitude` number — Longtitude - `name` string — Address name - `phone` string — Phone number Example 555-555-5555 - `province` string — Province - `province_code` string — The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada. - `updated_at` string, date-time — Updated at time - `zip` string — ZIP - `billing_address_same_as_shipping_address` boolean — Shipping address and Billing address are same or not - `buyer_accepts_marketing` boolean — Is buyer accept marketing - `cart_token` string — Cart token - `checkout_detail_paid_info` CheckoutDetailPaidInfo - `discount_code` string - `discount_total` number - `shipping_fee` number - `shipping_name` string - `subtotal_price` number - `tax_total` number - `total_price` number - `completed_at` string - `created_at` string - `currency` string — Shop currency - `customer` CustomerDto - `accepts_marketing` boolean — Whether the customer has consented to receive marketing material via email. - `addresses` CustomerAddressDetail[] — A list of the ten most recently updated addresses for the customer. - `address1` string — The customer's mailing address. - `address2` string — An additional field for the customer's mailing address. - `city` string — The customer's city, town, or village. - `company` string — The customer's company. - `country` string — The customer's country. - `country_code` string — The two-letter country code corresponding to the customer's country. - `country_id` integer — A unique identifier for the customer. - `country_name` string — The customer's normalized country name. - `cpf_number` string — Brazil CPF Number - `cpf_or_cnpj_number` string — CPF/CNPJ number - `created_at` string, date-time — Created at time - `default` boolean — Whether this address is the default address for the customer. - `first_name` string — The customer's first name. - `id` integer — A unique identifier for the address. - `last_name` string — The customer's last name. - `latitude` number — Latitude - `longitude` number — Longtitude - `name` string — Address name - `phone` string — Phone number Example 555-555-5555 - `province` string — Province - `province_code` string — The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada. - `updated_at` string, date-time — Updated at time - `zip` string — ZIP - `average_spent` number — The average amount of money that the customer has spent across their order history. - `created_at` string, date-time — The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the customer was created. - `currency` string — The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the currency that the customer used when they paid for their last order. Defaults to the shop currency. Returns the shop currency for test orders. - `default_address` CustomerAddressDetail - `address1` string — The customer's mailing address. - `address2` string — An additional field for the customer's mailing address. - `city` string — The customer's city, town, or village. - `company` string — The customer's company. - `country` string — The customer's country. - `country_code` string — The two-letter country code corresponding to the customer's country. - `country_id` integer — A unique identifier for the customer. - `country_name` string — The customer's normalized country name. - `cpf_number` string — Brazil CPF Number - `cpf_or_cnpj_number` string — CPF/CNPJ number - `created_at` string, date-time — Created at time - `default` boolean — Whether this address is the default address for the customer. - `first_name` string — The customer's first name. - `id` integer — A unique identifier for the address. - `last_name` string — The customer's last name. - `latitude` number — Latitude - `longitude` number — Longtitude - `name` string — Address name - `phone` string — Phone number Example 555-555-5555 - `province` string — Province - `province_code` string — The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada. - `updated_at` string, date-time — Updated at time - `zip` string — ZIP - `email` string — The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error. - `first_name` string — The customer's first name. - `id` integer — A unique identifier for the customer. - `last_name` string — The customer's last name. - `last_order_at` string, date-time — The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the customer purchase a last order - `last_order_id` integer — The ID of the customer's last order. - `last_order_name` string — The name of the customer's last order. This is directly related to the name field on the Order resource. - `last_sent_abandoned_email_at` string, date-time — The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the last abandoned checkout email was sent to this customer - `note` string — A note about the customer. - `orders_count` integer — The number of orders associated with this customer. - `phone` string — The unique phone number ([E.164 format](https://en.wikipedia.org/wiki/E.164)) for this customer. Attempting to assign the same phone number to multiple customers returns an error. The property can be set using different formats, but each format must represent a number that can be dialed from anywhere in the world. The following formats are all valid: * 6135551212 * +16135551212 * (613)555-1212 * +1 613-555-1212 - `state` string — The state of the customer's account with a shop. Default value: disabled. Valid values: * **disabled**: The customer doesn't have an active account. Customer acounts can be disabled from the ShopBase admin at any time. * **invited**: The customer has received an emailed invite to create an account. * **enabled**: The customer has created an account. * **declined**: The customer declined the email invite to create an account. - `tags` string — Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values. - `tax_exempt` boolean — Whether the customer is exempt from paying taxes on their order. If ```true```, then taxes won't be applied to an order at checkout. If ```false```, then taxes will be applied at checkout. - `total_spent` number — The total amount of money that the customer has spent across their order history. - `updated_at` string, date-time — The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the customer information was last updated. - `verified_email` boolean — Whether the customer has verified their email address. - `discount_applications` DiscountApplication[] - `allocation_method` string - `amount` number - `code` string - `discount_type` string - `is_valid` boolean - `price_rule_id` integer - `price_rule_title` string - `price_rule_type` string - `scope` string - `type` string - `value` number - `value_type` string - `discount_applied` boolean — Checkout has used discount or not - `discount_price` number — Discount amount of checkout - `email` string — customer email - `gateway` string — Payment gateway - `id` integer — Checkout ID - `line_items` OrderLineItemDto[] - `discount_allocations` OrderLineItemDiscountApplicationDto[] — An ordered list of amounts allocated by discount applications. - `amount` number — The discount amount allocated to the line in the shop currency. - `discount_application_index` integer — The index of the associated discount application in the order's discount_applications list. - `discount_amount` number — Discount amount - `fulfillable_quantity` integer — The amount available to fulfill, calculated as follows: `quantity - max(refunded_quantity, fulfilled_quantity) - pending_fulfilled_quantity - open_fulfilled_quantity` - `fulfillment_service` string — The service provider that's fulfilling the item. Valid values: manual, or the name of the provider, such as `amazon` or `shipwire`. - `fulfillment_status` string — How far along an order is in terms line items fulfilled. Valid values: null, processing, partial-processing, fulfilled, partial, and not_eligible. - `gift_card` boolean — Whether the item is a gift card. If `true`, then the item is not taxed or considered for shipping charges. - `image_src` string — Image source - `is_post_purchase_item` boolean — Is post purchase item - `item_discount_price` number — Item discount price - `line_item_discount_amount` number — Line item discount amount - `line_item_discount_price` number — Line item discount price - `line_item_price` number — Line item price - `line_item_price_after_discount` number — Line item price after discount - `line_item_price_before_discount` number — Line item price before discount - `line_item_price_with_explicit_discount` number — Line item price with explicit discount - `line_item_weight` number — Line item weight - `name` string — The name of the product variant. - `not_explicit_discount_price` number — Not explitcit discount price - `order_id` integer — Order ID - `price` number — The price of the item before discounts have been applied in the shop currency. - `product_id` integer — Product ID - `product_is_deleted` boolean — The status of product of this line item - `product_type` string — Product type - `properties` unknown[] — An array of custom information for the item that has been added to the cart. Often used to provide product customization options. - unknown - `quantity` number — Quantity items - `raw_price` number — Raw price - `raw_weight` number — Raw weight - `requires_shipping` boolean — Whether the item requires shipping. - `shipping_rate` LineItemShippingRate - `code` string — A reference to the combined shipping method. - `id` integer — The Shipping Rate Id - `is_post_purchase` boolean — Is post purchase - `price` number — The total price of this shipping rate for a variant in the order - `title` string — The title of the shipping method. - `type` string — The Shipping Rate Type - `variant_id` integer — The variant in which this shipping rate is applied for - `sku` string — The item's SKU (stock keeping unit). - `tags` string — A string of comma-separated product tags - `tax_amount` number — Tax amount - `tax_lines` TaxLineDto[] — An array of tax line objects, each of which details a tax applicable to the order. - `price` number — The amount added to the order for this tax in the shop currency. - `rate` number — The tax rate applied to the order to calculate the tax price. - `title` string — The name of the tax. - `tax_rate` number — Tax rate - `taxable` boolean — Whether the item was taxable. - `tip_payment_gateway` string — The payment gateway used to tender the tip, such as shopbase_payments. Present only on tips. - `tip_payment_method` string — The payment method used to tender the tip, such as Visa. Present only on tips. - `title` string — The title of the product. - `total_discount` number — The total discount amount applied to this line item in the shop currency. This value is not subtracted in the line item price. - `total_item_discount_price` number — Total item discount price - `total_line_with_discount_price` number — Total line with discount price - `total_tax_amount` number — Total tax amount - `variant_id` integer — Variant ID - `variant_title` string — The title of the product variant. - `vendor` string — The name of the item's supplier. - `weight` number — The weight of the item - `weight_unit` string — The weight unit of the item - `lock_send_email_reason` string — Reason not sent email - `name` string — Checkout name (base on id) - `note` string — Checkout note - `phone` string — customer phone number - `real_sent_at` string - `recovery_email_sent` boolean — Is recovery email sent - `scheduled_sent_at` string - `shipping_address` CustomerAddressDetail - `address1` string — The customer's mailing address. - `address2` string — An additional field for the customer's mailing address. - `city` string — The customer's city, town, or village. - `company` string — The customer's company. - `country` string — The customer's country. - `country_code` string — The two-letter country code corresponding to the customer's country. - `country_id` integer — A unique identifier for the customer. - `country_name` string — The customer's normalized country name. - `cpf_number` string — Brazil CPF Number - `cpf_or_cnpj_number` string — CPF/CNPJ number - `created_at` string, date-time — Created at time - `default` boolean — Whether this address is the default address for the customer. - `first_name` string — The customer's first name. - `id` integer — A unique identifier for the address. - `last_name` string — The customer's last name. - `latitude` number — Latitude - `longitude` number — Longtitude - `name` string — Address name - `phone` string — Phone number Example 555-555-5555 - `province` string — Province - `province_code` string — The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada. - `updated_at` string, date-time — Updated at time - `zip` string — ZIP - `shipping_discount` number — Caculated shipping discount - `shipping_fee` number — Caculated shipping fee - `shipping_method` ShippingMethod - `carrier_code` string - `discount_amount` number - `discounted_price` number - `method_code` string - `method_title` string - `price` number - `shipping_rates` ShippingRate[] - `cart_item_id` integer — The line item id which this shipping rate is applied for - `code` string — A reference to the combined shipping method. - `id` integer — The Shipping Rate Id - `is_post_purchase` boolean - `price` number — The total price of this shipping rate for a variant in the order - `raw` ShippingRateDto - `item_based` ItemBasedShippingRateDto - `additional_item_price` number - `created_at` integer - `exclude_rules` FilterRule[] - … - `first_item_price` number - `group_tag` string - `id` integer - `name` string - `price_unit` string - `rules` FilterRule[] - … - `shipping_zone_id` integer - `shop_id` integer - `updated_at` integer - `price_based` PriceBasedShippingRateDto - `created_at` integer - `free_ship` boolean - `id` integer - `max_order_subtotal` number - `min_order_subtotal` number - `name` string - `order_subtotal_unit` string - `price` number - `price_unit` string - `shipping_zone_id` integer - `shop_id` integer - `updated_at` integer - `profile_id` integer - `weight_based` WeightBasedShippingRateDto - `created_at` integer - `id` integer - `name` string - `price` number - `price_unit` string - `shipping_zone_id` integer - `shop_id` integer - `updated_at` integer - `weight_high` number - `weight_low` number - `weight_unit` string - `title` string — The title of the shipping method. - `type` string — The Shipping Rate Type - `variant_id` integer — The variant in which this shipping rate is applied for - `shipping_rule_id` integer - `shipping_rule_type` string - `shipping_name` string — Shipping name - `shipping_price` number — Shipping amount of checkout - `shipping_tax` number — Caculated shipping tax - `shop_id` integer — Shop ID - `subtotal_price` number — Subtotal price of checkout - `taxes_included` boolean — Is tax included - `token` string — Checkout token - `total_discounts` number — Total discount amount of checkout - `total_line_items_price` number — Total price of line item - `total_price` number — Total price of checkout - `total_shipping` number — it's equal shipping_fee - shipping_discount + shipping_tax - `total_tax` number — Total tax amount - `total_weight` number — Cart total weight - `updated_at` string --- [API](https://skmtc.net/shopbase/apis/shopbase-internal-api.md) · [All operations](https://skmtc.net/shopbase/apis/shopbase-internal-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shopbase/shopbase-internal-api/revisions/353ccde6240d/schema)