弃单

属性	说明	必含	类型
ID	弃单ID	是	[int]
note	备注	是	[string]
taxes_total	销售税	是	[string]
shipping_tax_total	运费税	是	[string]
order_currency	订单货币	是	[string]
order_shipping	订单物流	是	[string]
order_total	订单总价	是	[number]
cart_subtotal	购物车原价	是	[string]
post_date	创建时间	是	[datetime]
post_date_gmt	创建时间GMT	是	[datetime]
post_modified	更新时间	是	[datetime]
post_modified_gmt	更新时间GMT	是	[datetime]
ip	IP地址	是	[string]
cart_discount	购物车金额	是	[number]
number	弃单编号	是	[string]
country_or_region	国家/地区	是	[string]
cart_email	弃单邮件链接	是	[string]
recall_status	召回状态	是	[int]
checkout_emails	弃单邮件发送	是	[object]
checkout_emails>>id	邮件ID	是	[int]
checkout_emails>>checkout_id	弃单ID	是	[int]
checkout_emails>>template_id	模版ID	是	[string]
checkout_emails>>is_sent	是否发送	是	[int]
checkout_emails>>is_need_send	是否需要发送	是	[int]
checkout_emails>>send_time	捡	是	[datetime]
checkout_emails>>created_at_gmt	创建时间GMT	是	[datetime]
checkout_emails>>updated_at_gmt	更新时间GMT	是	[datetime]
checkout_emails>>created_at	创建时间	是	[datetime]
checkout_emails>>updated_at	更新时间	是	[datetime]
checkout_email_total_num	邮件发送总数	是	[string]
checkout_email_share_status	是否点击	是	[string]
checkout_email_is_canceled	是否取消	是	[string]
checkout_email_is_manual	是否手动发送	是	[string]
checkout_email_manual_send_total_num	手动发送数	是	[int]
custom_attributes	自定义属性	是	[array]
order_id	订单ID	是	[int]
customer_email	顾客邮箱	是	[string]
billing_user_name	账单姓名	是	[string]
payment_method	支付方式	是	[string]
payment_method_title	支付方式名称	是	[string]
shipping_address	物流地址	是	[object]
shipping_address>>first_name	名	是	[string]
shipping_address>>last_name	姓	是	[string]
shipping_address>>country	国家	是	[string]
shipping_address>>state	州	是	[string]
shipping_address>>postcode	邮编	是	[string]
shipping_address>>city	城市	是	[string]
shipping_address>>address_1	地址1	是	[string]
shipping_address>>address_2	地址2	是	[string]
shipping_address>>phone	电话	是	[string]
shipping_address>>email	邮箱	是	[string]
shipping_address>>address_note	地址备注	是	[string]
shipping_address>>address_index	地址索引	是	[string]
shipping_address>>state_name	州名称	是	[string]
billing_address	账单地址	是	[object]
billing_address>>first_name	名	是	[string]
billing_address>>last_name	性	是	[string]
billing_address>>country	国家	是	[string]
billing_address>>state	州	是	[string]
billing_address>>postcode	邮编	是	[string]
billing_address>>city	城市	是	[string]
billing_address>>address_1	地址1	是	[string]
billing_address>>address_2	地址2	是	[string]
billing_address>>phone	电话	是	[string]
billing_address>>email	邮箱地址	是	[string]
billing_address>>subscribed	订阅状态	是	[string]
billing_address>>address_index	地址索引	是	[string]
billing_address>>state_name	州名	是	[string]
lineitems	商品信息	是	[object]
lineitems>>qty	数量	是	[int]
lineitems>>line_total	总价	是	[number]
lineitems>>line_tax	总税费	是	[int]
lineitems>>line_subtotal	总价	是	[string]
lineitems>>line_subtotal_tax	总税费	是	[int]
lineitems>>product_id	商品ID	是	[int]
lineitems>>variation_id	变种ID	是	[int]
lineitems>>properties	属性	是	[array]
lineitems>>tax_class	计税类型	是	[string]
lineitems>>order_item_name	商品名称	是	[string]
lineitems>>price	价格	是	[number]
lineitems>>feature_image	图片	是	[array]
lineitems>>sku	SKU	是	[string]
lineitems>>attrs	属性	是	[array]
lineitems>>regular_price	原价	是	[number]
lineitems>>public_url	公开链接	是	[string]
shippings	物流	否	[object]
shippings>>order_item_name	订单项名	否	[string]
shippings>>method_id	物流 ID	否	[string]
shippings>>instance_id	实例 ID	否	[int]
shippings>>cost	物流费用	否	[number]
shippings>>total_tax	总税费	否	[number]
shippings>>taxes	税费	否	[number]
fees	附加费用	否	[array]
fees>>order_item_name	项目名称	否	[string]
fees>>fee_amount	费用总价	否	[string]
fees>>tax_class	税费种类	否	[string]
fees>>tax_status	税费状态	否	[string]
fees>>line_total	项目费用	否	[string]
fees>>line_tax	税费	否	[number]
fees>>line_tax_data	税费详情	否	[array]
fees>>rate	费率	否	[string]
discount_record	优惠记录	否	[array]
discount_record>>code	优惠码	否	[string]
discount_record>>amount	优惠总额	否	[string]
discount_record>>rule_id	优惠ID	否	[int]
discount_record>>rule_data	优惠数据	否	[array]
discount_record>>auto_coupon	是否自动优惠	否	[boolean]
discount_record>>description	优惠描述	否	[string]
discount_record>>product_ids	优惠商品 ID集合	否	[array]
discount_record>>discount_type	优惠类型	否	[string]
discount_record>>free_shipping	是否免运费	否	[boolean]
customer	顾客信息	否	[array]
customer>>ID	顾客 ID	否	[int]
customer>>user_login	顾客登录时间	否	[datetime]
customer>>user_nicename	顾客昵称	否	[string]
customer>>user_email	顾客邮箱	否	[string]
customer>>user_registered	用户注册时间	否	[datetime]
customer>>user_status	用户状态	否	[int]
customer>>display_name	展示名称	否	[string]
customer>>country	国家	否	[string]
customer>>subscribed	订阅状态	否	[boolean]
customer>>order_count	订单数	否	[int]
customer>>order_total	订单总额	否	[number]
customer>>phone	电话	否	[string]
customer>>type	类型	否	[string]
customer>>first_name	名	否	[string]
customer>>last_name	姓	否	[string]
customer>>address_book	地址簿	否	[array]
customer>>shipping_address	物流地址	否	[array]
customer>>billing_address	账单地址	否	[array]
customer>>billing_country	账单国家	否	[string]
customer>>nickname	昵称	否	[string]
customer>>created_at	创建时间	否	[datetime]
customer>>updated_at	更新时间	否	[datetime]
conversion_summary	弃单摘要	是	[object]
conversion_summary>>checkout_id	弃单 ID	是	[int]
conversion_summary>>checkout_index	弃单排序（第几个弃单）	是	[int]
conversion_summary>>step_before_leaving	最后的步骤（放弃于哪里）	是	[string]
conversion_summary>>created_from_source	生成弃单来源	是	[string]
conversion_summary>>interact_times	交互次数	是	[int]
conversion_summary>>device	设备	是	[string]
conversion_summary>>ip	IP	是	[string]
conversion_summary>>payment_method	支付方式	是	[string]
conversion_summary>>first_visit	首次交互访问记录	是	[string]
conversion_summary>>first_visit>>landing_page	落地页信息	是	[string]
conversion_summary>>first_visit>>utm_parameters	utm 参数	是	[object]
conversion_summary>>first_visit>>utm_parameters>>utm_source	utm 来源	否	[string]
conversion_summary>>first_visit>>utm_parameters>>utm_medium	utm 媒介	否	[string]
conversion_summary>>first_visit>>utm_parameters>>utm_campaign		否	[string]
conversion_summary>>first_visit>>utm_parameters>>utm_term		否	[string]
conversion_summary>>first_visit>>utm_parameters>>utm_content		否	[string]
conversion_summary>>first_visit>>referrer_url	来源地址	是	[string]
conversion_summary>>first_visit>>interact_source	交互来源	是	[string]
conversion_summary>>first_visit>>created_at	创建时间	是	[string]
conversion_summary>>first_visit>>created_at	创建时间 gmt	是	[string]
conversion_summary>>last_visit	末次交互访问记录	是	[object]
conversion_summary>>last_visit>>landing_page	落地页信息	是	[string]
conversion_summary>>last_visit>>utm_parameters	utm 参数	是	[string]
conversion_summary>>last_visit>>utm_parameters>>utm_source	utm 来源	否	[string]
conversion_summary>>last_visit>>utm_parameters>>utm_medium	utm 媒介	否	[string]
conversion_summary>>last_visit>>utm_parameters>>utm_campaign		否	[string]
conversion_summary>>last_visit>>utm_parameters>>utm_term		否	[string]
conversion_summary>>last_visit>>utm_parameters>>utm_content		否	[string]
conversion_summary>>last_visit>>referrer_url	来源地址	是	[string]
conversion_summary>>last_visit>>interact_source	交互来源	是	[string]
conversion_summary>>last_visit>>created_at	创建时间	是	[string]
conversion_summary>>last_visit>>created_at_gmt	创建时间 gmt	是	[string]

获取弃单列表

GET /openapi/2023-10/checkouts

权限：read_orders

Query Parameters

Name	Type	Description
filter[search]	String	模糊匹配订单编号、商品名称、SKU、支付编号、顾客邮箱，格式如：filter[search]=4D963207C5032370E
filter[country_or_region]	String	根据国家或者地区搜索
filter[recall_status]	String	召回状态：1-已召回,0-未召回，格式如：filter[recall_status]=1
filter[post_date]	String	按时间匹配,格式如:filter[date]=2019-12-16,2020-03-05
filter[email_status]	String	邮件状态： 0-未发送，1-已发送，格式如：filter[email_status]=1

200: OK

{
    "data": [
        {
            "ID": 15002401,
            "note": "",
            "order_currency": "USD",
            "order_shipping": "0.00",
            "order_total": "15.19",
            "cart_subtotal": "9.99",
            "post_date": "2024-06-13 19:20:55",
            "post_date_gmt": "2024-06-14T03:20:55+00:00",
            "post_modified": "2024-06-13 19:21:13",
            "post_modified_gmt": "2024-06-14 03:21:13",
            "ip": "54.219.251.239",
            "cart_discount": "0.00",
            "number": "55702024061319205529909",
            "country_or_region": "US",
            "cart_email": "https://shop.com/checkouts/fd78f44f336ade8835753c6f735f2d6f/recover?key=a3cfec366d5c47b885c6c5c2ef35ae51&step=contact_information&utm_medium=email&utm_campaign=m_checkout_reminder&utm_source=m_checkout&abt=sale",
            "recall_status": 0,
            "checkout_emails": [
                {
                    "id": 4791,
                    "checkout_id": 15002401,
                    "template_id": "1",
                    "is_sent": 1,
                    "is_need_send": 1,
                    "send_time": "2024-06-13T19:26:07-08:00",
                    "send_time_gmt": "2024-06-14 03:26:07",
                    "created_at_gmt": "0000-00-00 00:00:00",
                    "updated_at_gmt": "0000-00-00 00:00:00",
                    "created_at": "2024-06-13 19:21:07",
                    "updated_at": "2024-06-13 19:26:07",
                    "coupon_code": ""
                },
                {
                    "id": 4792,
                    "checkout_id": 15002401,
                    "template_id": "2",
                    "is_sent": 1,
                    "is_need_send": 1,
                    "send_time": "2024-06-13T19:26:07-08:00",
                    "send_time_gmt": "2024-06-14 03:26:07",
                    "created_at_gmt": "0000-00-00 00:00:00",
                    "updated_at_gmt": "0000-00-00 00:00:00",
                    "created_at": "2024-06-13 19:21:07",
                    "updated_at": "2024-06-13 19:26:07",
                    "coupon_code": ""
                }
            ],
            "checkout_email_total_num": "1",
            "checkout_email_share_status": "1",
            "checkout_email_is_canceled": "0",
            "checkout_email_is_manual": "0",
            "checkout_email_manual_send_total_num": 0,
            "order_id": null,
            "customer_email": "[e-mail]",
            "billing_user_name": "Harry Potter",
            "taxes_total": "5.00",
            "shipping_tax_total": "0.00",
            "payment_method": "omnipay",
            "payment_method_title": "Omnipay",
            "shipping_address": {
                "first_name": "Harry",
                "last_name": "Potter",
                "country": "US",
                "state": "FL",
                "postcode": "32323",
                "city": "Lanark Village",
                "address_1": "32323",
                "address_2": "",
                "phone": "[phone]",
                "email": "[e-mail]",
                "address_note": "",
                "address_index": "Harry Potter 32323  Lanark Village FL US 32323 [phone]",
                "state_name": "Florida"
            },
            "billing_address": {
                "first_name": "Harry",
                "last_name": "Potter",
                "country": "US",
                "state": "FL",
                "postcode": "32323",
                "city": "Lanark Village",
                "address_1": "32323",
                "address_2": "",
                "phone": "[phone]",
                "email": "[e-mail]",
                "subscribed": "",
                "address_index": "Harry Potter 32323  Lanark Village FL US 32323 [phone]",
                "state_name": "Florida"
            },
            "lineitems": [
                {
                    "qty": 1,
                    "line_total": "9.99",
                    "line_tax": 5,
                    "line_subtotal": "9.99",
                    "line_subtotal_tax": 0,
                    "product_id": 9620,
                    "variation_id": 9621,
                    "properties": [

                    ],
                    "tax_class": "",
                    "order_item_name": "主商品B - 0.00/Plano / blue",
                    "price": 9.99,
                    "feature_image": {
                        "ID": 9615,
                        "alt": "",
                        "url": "https://cdn.com/image/2022/10/d086c70aa468be5b38c41bdec097748b653457bbed74569b51bcc337399e195d.jpeg",
                        "file_id": 1821,
                        "thumbnail": "https://cdn.com/image/2022/10/d086c70aa468be5b38c41bdec097748b653457bbed74569b51bcc337399e195d.jpeg",
                        "media_content_type": "image"
                    },
                    "sku": "荔枝汽水_0.00",
                    "attrs": [
                        {
                            "name": "Power",
                            "value": "0.00/Plano"
                        },
                        {
                            "name": "Color",
                            "value": "blue"
                        }
                    ],
                    "regular_price": 29.99,
                    "public_url": "https://shop.com/products/lychee-grey-1"
                }
            ],
            "custom_attributes": []
        }
    ]
}

获取弃单数量

GET /openapi/2023-10/checkouts/count

权限：read_orders

200: OK

{
    "count": 43
}

获取弃单详情

GET /openapi/2023-10/checkouts/{id}

权限：read_orders

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Response

200

{
    "data": {
        "ID": 15002401,
        "note": "",
        "order_currency": "USD",
        "order_shipping": "0.00",
        "order_total": "15.19",
        "cart_subtotal": "9.99",
        "post_date": "2024-06-13 19:20:55",
        "post_date_gmt": "2024-06-14T03:20:55+00:00",
        "post_modified": "2024-06-13 19:21:13",
        "post_modified_gmt": "2024-06-14 03:21:13",
        "ip": "54.219.251.239",
        "cart_discount": "0.00",
        "number": "55702024061319205529909",
        "country_or_region": "US",
        "cart_email": "https://shop.com/checkouts/fd78f44f336ade8835753c6f735f2d6f/recover?key=a3cfec366d5c47b885c6c5c2ef35ae51&step=contact_information&utm_medium=email&utm_campaign=m_checkout_reminder&utm_source=m_checkout&abt=sale",
        "recall_status": 0,
        "checkout_emails": [
            {
                "id": 4791,
                "checkout_id": 15002401,
                "template_id": "1",
                "is_sent": 1,
                "is_need_send": 1,
                "send_time": "2024-06-13T19:26:07-08:00",
                "send_time_gmt": "2024-06-14 03:26:07",
                "created_at_gmt": "0000-00-00 00:00:00",
                "updated_at_gmt": "0000-00-00 00:00:00",
                "created_at": "2024-06-13 19:21:07",
                "updated_at": "2024-06-13 19:26:07",
                "coupon_code": ""
            },
            {
                "id": 4792,
                "checkout_id": 15002401,
                "template_id": "2",
                "is_sent": 1,
                "is_need_send": 1,
                "send_time": "2024-06-13T19:26:07-08:00",
                "send_time_gmt": "2024-06-14 03:26:07",
                "created_at_gmt": "0000-00-00 00:00:00",
                "updated_at_gmt": "0000-00-00 00:00:00",
                "created_at": "2024-06-13 19:21:07",
                "updated_at": "2024-06-13 19:26:07",
                "coupon_code": ""
            }
        ],
        "checkout_email_total_num": "1",
        "checkout_email_share_status": "1",
        "checkout_email_is_canceled": "0",
        "checkout_email_is_manual": "0",
        "checkout_email_manual_send_total_num": 0,
        "order_id": null,
        "customer_email": "[e-mail]",
        "billing_user_name": "Harry Potter",
        "taxes_total": "5.00",
        "shipping_tax_total": "0.00",
        "payment_method": "omnipay",
        "payment_method_title": "Omnipay",
        "shippings": [
            {
                "order_item_name": "free",
                "method_id": "advanced_flat_rate_shipping",
                "instance_id": 0,
                "cost": 0,
                "total_tax": 0,
                "taxes": []
            }
        ],
        "coupons": [],
        "fees": [
            {
                "order_item_name": "Shipping Insurance",
                "fee_amount": "0.20",
                "tax_class": "",
                "tax_status": "taxable",
                "line_total": "0.20",
                "line_tax": 0,
                "line_tax_data": [],
                "rate": 0
            }
        ],
        "discount_record": [],
        "customer": {
            "ID": 518,
            "user_login": "[e-mail]",
            "user_nicename": "Harry PotterHarry Potter",
            "user_email": "[e-mail]",
            "user_registered": "2024-04-16 00:44:34",
            "user_status": 2,
            "display_name": "Harry Potter Harry Potter",
            "updated_at_gmt": "2024-06-14 03:21:13",
            "country": "US",
            "subscribed": true,
            "order_count": 91,
            "order_total": 10010.74,
            "phone": "[phone]",
            "type": "registered",
            "first_name": "Harry Potter",
            "last_name": "Harry Potter",
            "address_book": null,
            "billing_address": [],
            "shipping_address": [],
            "billing_country": null,
            "nickname": "Harry PotterHarry Potter",
            "created_at": "2024-04-16 00:44:34",
            "updated_at": "2024-06-13 19:21:13"
        },
        "shipping_address": {
            "first_name": "Harry",
            "last_name": "Potter",
            "country": "US",
            "state": "FL",
            "postcode": "32323",
            "city": "Lanark Village",
            "address_1": "32323",
            "address_2": "",
            "phone": "[phone]",
            "email": "[e-mail]",
            "address_note": "",
            "address_index": "Harry Potter 32323  Lanark Village FL US 32323 [phone]",
            "state_name": "Florida"
        },
        "billing_address": {
            "first_name": "Harry",
            "last_name": "Potter",
            "country": "US",
            "state": "FL",
            "postcode": "32323",
            "city": "Lanark Village",
            "address_1": "32323",
            "address_2": "",
            "phone": "[phone]",
            "email": "[e-mail]",
            "subscribed": "",
            "address_index": "Harry Potter 32323  Lanark Village FL US 32323 [phone]",
            "state_name": "Florida"
        },
        "lineitems": [
            {
                "qty": 1,
                "line_total": "9.99",
                "line_tax": 5,
                "line_subtotal": "9.99",
                "line_subtotal_tax": 0,
                "product_id": 9620,
                "variation_id": 9621,
                "properties": [],
                "tax_class": "",
                "order_item_name": "主商品B - 0.00/Plano / blue",
                "price": 9.99,
                "feature_image": {
                    "ID": 9615,
                    "alt": "",
                    "url": "https://cdn.com/image/2022/10/d086c70aa468be5b38c41bdec097748b653457bbed74569b51bcc337399e195d.jpeg",
                    "file_id": 1821,
                    "thumbnail": "https://cdn.com/image/2022/10/d086c70aa468be5b38c41bdec097748b653457bbed74569b51bcc337399e195d.jpeg",
                    "media_content_type": "image"
                },
                "sku": "荔枝汽水_0.00",
                "attrs": [
                    {
                        "name": "Power",
                        "value": "0.00/Plano"
                    },
                    {
                        "name": "Color",
                        "value": "blue"
                    }
                ],
                "regular_price": 29.99,
                "public_url": "https://shop.com/products/lychee-grey-1"
            }
        ],
        "custom_attributes": [],
        "conversion_summary": {
            "checkout_id": 15002401,
            "checkout_index": 34,
            "step_before_leaving": "Information",
            "created_from_source": "Facebook",
            "interact_times": 1,
            "device": "Computer",
            "ip": "54.219.251.239",
            "first_visit": {
                "landing_page": "https://shop.com/?utm_source=fb&utm_medium=Facebook_Right_Column&utm_campaign=23843343363350716&utm_term=23843343379110716&utm_content=23843343379100716&fbclid=IwAR2gdodchsKE6AbjL2TfW41s3N2D80-Kd4Iy6nDWdnJjjNYXQTR7lhcCJtU",
                "utm_parameters": {
                    "utm_source": "fb",
                    "utm_medium": "Facebook_Right_Column",
                    "utm_campaign": "23843343363350716",
                    "utm_term": "23843343379110716",
                    "utm_content": "23843343379100716"
                },
                "referrer_url": "",
                "interact_source": "Facebook",
                "created_at": "2024-05-16 05:05:27",
                "created_at_gmt": "2024-05-16 13:05:27"
            },
            "last_visit": {
                "landing_page": "https://shop.com/?utm_source=fb&utm_medium=Facebook_Right_Column&utm_campaign=23843343363350716&utm_term=23843343379110716&utm_content=23843343379100716&fbclid=IwAR2gdodchsKE6AbjL2TfW41s3N2D80-Kd4Iy6nDWdnJjjNYXQTR7lhcCJtU",
                "utm_parameters": {
                    "utm_source": "fb",
                    "utm_medium": "Facebook_Right_Column",
                    "utm_campaign": "23843343363350716",
                    "utm_term": "23843343379110716",
                    "utm_content": "23843343379100716"
                },
                "referrer_url": "",
                "interact_source": "Facebook",
                "created_at": "2024-05-16 05:05:27",
                "created_at_gmt": "2024-05-16 13:05:27"
            },
            "payment_method": ""
        }
    }
}