This is used to return abandoned checkouts. A checkout is considered abandoned when a customer has entered their billing & shipping info, but has yet to complete the purchase.
Authenticated access scopes: com.read_orders, com.write_orders
What you can do with Checkout
The Haravan API lets you do the following with the Checkout resource.
Checkout properties
Endpoints
Retrieves a list of all refunds of order. You can filter resources by params.
limit | integer ≤ 50 default 50 The maximum number of results to show on a page. |
page | Page to show the result. |
since_id | Restrict results to after the specified ID |
created_at_min | Show orders created after date (format: 2021-10-20T14:07:45.084Z) |
created_at_max | Show orders created before date (format: 2021-10-20T14:07:45.084Z) |
updated_at_min | Show orders last updated after date (format: 2021-10-20T14:07:45.084Z) |
updated_at_max | Show orders last updated before date (format: 2021-10-20T14:07:45.084Z) |
fields | comma-separated list of fields to include in the response. |
Retrieve all checkouts.
GET https://apis.haravan.com/com/checkouts.json
HTTP/1.1 200 OK
{ "checkouts": [ { "abandoned_checkout_url": "http://haravanshop.myharavan.com/checkouts/02abbaa9f0a14d69ad4a8bd6ee54f150/recover", "billing_address": { "address1": "Hồ Chí Minh", "address2": null, "city": null, "company": null, "country": "Vietnam", "first_name": "Thanh", "id": 1047004563, "last_name": "Thanh", "phone": "969696969", "province": "Cà Mau", "zip": "", "name": "Thanh Thanh", "province_code": null, "country_code": "VN", "default": true, "district": null, "district_code": null, "ward": null, "ward_code": null }, "buyer_accepts_marketing": false, "cancel_reason": null, "cart_token": "266251a49f9e405d9ded10d5d50b5537", "closed_at": null, "completed_at": null, "created_at": "2021-06-07T13:20:41.815Z", "currency": "VND", "customer": { "accepts_marketing": false, "addresses": [ { "address1": "Hồ Chí Minh", "address2": null, "city": null, "company": null, "country": "Vietnam", "first_name": "t", "id": 1079395393, "last_name": "t", "phone": "0969696969", "province": "Cà Mau", "zip": "70000", "name": "t t", "province_code": "CM", "country_code": "vn", "default": true, "district": "Thành phố Cà Mau", "district_code": "CM666", "ward": null, "ward_code": null } ], "created_at": "2021-06-07T13:20:41.749Z", "default_address": { "address1": "Hồ Chí Minh", "address2": null, "city": null, "company": null, "country": "Vietnam", "first_name": "Thanh", "id": 1079395393, "last_name": "Thanh", "phone": "0969696969", "province": "Cà Mau", "zip": "70000", "name": "Thanh Thanh", "province_code": "CM", "country_code": "vn", "default": true, "district": "Thành phố Cà Mau", "district_code": "CM666", "ward": null, "ward_code": null }, "email": null, "phone": "0969696969", "first_name": "Thanh", "id": 1047004563, "multipass_identifier": null, "last_name": "Thanh", "last_order_id": null, "last_order_name": null, "note": null, "orders_count": 0, "state": "Disabled", "tags": null, "total_spent": 0.0000, "total_paid": 0.0, "updated_at": "2021-06-07T13:20:41.749Z", "verified_email": false, "send_email_invite": false, "send_email_welcome": false, "password": null, "password_confirmation": null, "group_name": "", "metafields": null, "birthday": null, "gender": null, "last_order_date": null }, "discount_codes": [], "email": null, "gateway": null, "id": 1203691418, "landing_site": "/collections/all", "line_items": [ { "fulfillment_service": null, "fulfillment_status": null, "grams": 0.0000, "price": 18990000.0000, "product_id": 1033237559, "quantity": 1, "requires_shipping": false, "sku": null, "title": "Điện thoại Samsung Galaxy S21 5G", "variant_id": 1073121320, "variant_title": "Tím", "vendor": "Khác", "name": "Điện thoại Samsung Galaxy S21 5G - Tím", "id": 1243058450, "barcode": null, "properties": [] } ], "note": "", "referring_site": "", "shipping_address": { "address1": "", "address2": "", "city": null, "company": "", "country": "Vietnam", "first_name": "", "last_name": "", "latitude": null, "longitude": null, "phone": "", "province": "Cà Mau", "zip": "", "name": "", "province_code": null, "country_code": "VN", "district_code": null, "district": null, "ward_code": null, "ward": null }, "shipping_lines": [], "source_name": "web", "subtotal_price": 18990000.0000, "taxe_lines": null, "taxes_included": false, "token": "266251a49f9e405d9ded10d5d50b5537", "total_discounts": 0.0, "total_line_items_price": 18990000.0000, "total_price": 18990000.0000, "total_tax": 0.0, "total_weight": 0.0000, "updated_at": "2021-06-07T13:20:41.815Z", "note_attributes": [], "name": "#1000000448", "landing_site_ref": null, "source": "checkout_next", "location_id": null } ] }
Get a count of checkouts.
GET https://apis.haravan.com/com/checkouts/count.json
HTTP/1.1 200 OK
{ "count": 11 }