Checkout
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.What can you do with Checkout?
The haravan API lets you do the following with the Checkout resource. More detailed versions of these general actions may be available:
- GET /admin/checkouts/count.json Receive a count of all Checkouts
- GET /admin/checkouts.json Receive a list of all Checkouts
Checkout Properties
abandoned_checkout_url |
The full recovery URL to be sent to a customer to recover their abandoned checkout. |
billing_address |
The mailing address associated with the payment method. It has the following properties:
|
buyer_accepts_marketing |
Indicates whether or not the person who placed the order would like to receive email updates from the shop. This is set when checking the "I want to receive occasional emails about new products, promotions and other news" checkbox during checkout. Valid values are "true" and "false." |
cancel_reason |
The reason why the order was cancelled. If the order was not cancelled, this value is "null." If the order was cancelled, the value will be one of the following:
|
cart_token |
Unique identifier for a particular cart that is attached to a particular order. |
closed_at |
The date and time when the order was closed. If the order was closed, the API returns this value in ISO 8601 format. If the order was not closed, this value is null. |
completed_at |
|
created_at |
The date and time when the order was created. The API returns this value in ISO 8601 format. |
currency |
The three letter code (ISO 4217) for the currency used for the payment. |
customer |
An object containing information about the customer. It contains the following fields:
|
discount_codes |
Applicable discount codes that can be applied to the order. If no codes exist the value will default to blank. A Discount code will include the following fields:
|
The customer's email address. | |
gateway |
The payment gateway used. |
id |
The unique numeric identifier for the order. This one is used for API purposes. This is different from the order_number property (see below), which is also a unique numeric identifier for the order, but used by the shop owner and customer. |
landing_site |
The URL for the page where the buyer landed when entering the shop. |
line_items |
A list of line item objects, each one containing information about an item in the order. Each
|
note |
The text of an optional note that a shopowner can attach to the order. |
referring_site |
The website that the customer clicked on to come to the shop. |
shipping_address |
The mailing address to where the order will be shipped. It has the following properties:
|
shipping_lines |
An array of
|
source_name |
Where the checkout originated. Possible values are: "web", "pos", "iphone", and "android" |
subtotal_price |
Price of the order before shipping and taxes |
tax_lines |
An array of
|
taxes_included |
|
token |
Unique identifier for a particular order. |
total_discounts |
The total amount of the discounts to be applied to the price of the order. |
total_line_items_price |
The sum of all the prices of all the items in the order. |
total_price |
The sum of all the prices of all the items in the order, taxes and discounts included. |
total_tax |
The sum of all the taxes applied to the line items in the order. |
total_weight |
The sum of all the weights of the line items in the order, in grams. |
updated_at |
The date and time when the order was last modified. The API returns this value in ISO 8601 format. |
Endpoints
GET/admin/checkouts/count.json
Get a count of checkouts
since_id | Restrict results to after the specified ID |
created_at_min | Show checkouts created after date (format: 2008-12-31 03:00) |
created_at_max | Show checkouts created before date (format: 2008-12-31 03:00) |
updated_at_min | Show checkouts last updated after date (format: 2008-12-31 03:00) |
updated_at_max | Show checkouts last updated before date (format: 2008-12-31 03:00) |
status |
|
GET/admin/checkouts.json
limit | Amount of results (default: 50) (maximum: 250) |
page | Page to show (default: 1) |
since_id | Restrict results to after the specified ID |
created_at_min | Show checkouts created after date (format: 2008-12-31 03:00) |
created_at_max | Show checkouts created before date (format: 2008-12-31 03:00) |
updated_at_min | Show checkouts last updated after date (format: 2008-12-31 03:00) |
updated_at_max | Show checkouts last updated before date (format: 2008-12-31 03:00) |
status |
|
List all abandoned checkouts
GET /admin/checkouts.jsonView Response
HTTP/1.1 200 OK { "checkouts": [ { "buyer_accepts_marketing": false, "cart_token": "68778783ad298f1c80c3bafcddeea02f", "closed_at": null, "completed_at": null, "created_at": "2012-10-12T07:05:27-04:00", "currency": "USD", "email": "bob.norman@hostmail.com", "gateway": null, "id": 450789469, "landing_site": null, "note": null, "referring_site": null, "shipping_lines": [ { "title": "Free Shipping", "price": "0.00", "code": "Free Shipping", "source": "haravan" } ], "source_identifier": null, "source_url": null, "subtotal_price": "398.00", "taxes_included": false, "token": "2a1ace52255252df566af0faaedfbfa7", "total_discounts": "39.80", "total_line_items_price": "398.00", "total_price": "379.69", "total_tax": "21.49", "total_weight": 400, "updated_at": "2012-10-12T07:05:27-04:00", "line_items": [ { "applied_discounts": [ ], "compare_at_price": null, "fulfillment_service": "manual", "gift_card": false, "grams": 200, "line_price": "199.00", "price": "199.00", "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", "vendor": "Apple" }, { "applied_discounts": [ ], "compare_at_price": null, "fulfillment_service": "manual", "gift_card": false, "grams": 200, "line_price": "199.00", "price": "199.00", "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", "vendor": "Apple" } ], "name": "#450789469", "note_attributes": [ { "name": "custom engraving", "value": "Happy Birthday" }, { "name": "colour", "value": "green" } ], "source": "browser", "discount_codes": [ { "code": "TENOFF", "amount": "39.80", "type": "percentage" } ], "abandoned_checkout_url": "https:\/\/checkout.local\/orders\/690933842\/2a1ace52255252df566af0faaedfbfa7?recovered=1", "tax_lines": [ { "price": "21.49", "rate": 0.06, "title": "State Tax" } ], "source_name": "web", "billing_address": { "address1": "Chestnut Street 92", "address2": "", "city": "Louisville", "company": null, "country": "United States", "first_name": "Bob", "last_name": "Norman", "latitude": 45.41634, "longitude": -75.6868, "phone": "555-625-1199", "province": "Kentucky", "zip": "40202", "name": "Bob Norman", "country_code": "US", "province_code": "KY" }, "shipping_address": { "address1": "Chestnut Street 92", "address2": "", "city": "Louisville", "company": null, "country": "United States", "first_name": "Bob", "last_name": "Norman", "latitude": 45.41634, "longitude": -75.6868, "phone": "555-625-1199", "province": "Kentucky", "zip": "40202", "name": "Bob Norman", "country_code": "US", "province_code": "KY" }, "customer": { "accepts_marketing": false, "created_at": "2015-03-28T13:26:28-04:00", "email": "bob.norman@hostmail.com", "first_name": "Bob", "id": 207119551, "last_name": "Norman", "last_order_id": 450789469, "multipass_identifier": null, "note": null, "orders_count": 1, "state": "disabled", "total_spent": "41.94", "updated_at": "2015-03-28T13:26:28-04:00", "verified_email": true, "tags": "", "last_order_name": "#1001", "default_address": { "address1": "Chestnut Street 92", "address2": "", "city": "Louisville", "company": null, "country": "United States", "first_name": null, "id": 207119551, "last_name": null, "phone": "555-625-1199", "province": "Kentucky", "zip": "40202", "name": "", "province_code": "KY", "country_code": "US", "country_name": "United States", "default": true } } }, { "buyer_accepts_marketing": false, "cart_token": "68778783ad298f1c80c3bafcddeea02f", "closed_at": null, "completed_at": null, "created_at": "2012-10-12T07:05:27-04:00", "currency": "USD", "email": "bob.norman@hostmail.com", "gateway": null, "id": 590063353, "landing_site": null, "note": null, "referring_site": null, "shipping_lines": [ { "title": "Free Shipping", "price": "0.00", "code": "Free Shipping", "source": "haravan" } ], "source_identifier": null, "source_url": null, "subtotal_price": "398.00", "taxes_included": false, "token": "zs9ru89kuqcdagk8bz4r9hnxt22wwd42", "total_discounts": "0.00", "total_line_items_price": "398.00", "total_price": "409.94", "total_tax": "11.94", "total_weight": 400, "updated_at": "2012-10-12T07:05:27-04:00", "line_items": [ { "applied_discounts": [ ], "compare_at_price": null, "fulfillment_service": "manual", "gift_card": false, "grams": 200, "line_price": "1990.00", "price": "199.00", "product_id": 632910392, "properties": null, "quantity": 10, "requires_shipping": true, "sku": "IPOD2008RED", "tax_lines": [ ], "taxable": true, "title": "IPod Nano - 8GB", "variant_id": 49148385, "variant_title": "Red", "vendor": "Apple" }, { "applied_discounts": [ ], "compare_at_price": null, "fulfillment_service": "manual", "gift_card": false, "grams": 200, "line_price": "1990.00", "price": "199.00", "product_id": 632910392, "properties": null, "quantity": 10, "requires_shipping": true, "sku": "IPOD2008PINK", "tax_lines": [ ], "taxable": true, "title": "IPod Nano - 8GB", "variant_id": 808950810, "variant_title": "Pink", "vendor": "Apple" } ], "name": "#590063353", "note_attributes": [ { "name": "custom engraving", "value": "Happy Birthday" }, { "name": "colour", "value": "green" } ], "source": "anywhere", "discount_codes": [ ], "abandoned_checkout_url": "https:\/\/checkout.local\/690933842\/checkouts\/zs9ru89kuqcdagk8bz4r9hnxt22wwd42\/recover", "tax_lines": [ { "price": "11.94", "rate": 0.06, "title": "State Tax" } ], "source_name": "anywhere", "billing_address": { "address1": "Chestnut Street 92", "address2": "", "city": "Louisville", "company": null, "country": "United States", "first_name": "Bob", "last_name": "Norman", "latitude": 45.41634, "longitude": -75.6868, "phone": "555-625-1199", "province": "Kentucky", "zip": "40202", "name": "Bob Norman", "country_code": "US", "province_code": "KY" }, "shipping_address": { "address1": "Chestnut Street 92", "address2": "", "city": "Louisville", "company": null, "country": "United States", "first_name": "Bob", "last_name": "Norman", "latitude": 45.41634, "longitude": -75.6868, "phone": "555-625-1199", "province": "Kentucky", "zip": "40202", "name": "Bob Norman", "country_code": "US", "province_code": "KY" }, "customer": { "accepts_marketing": false, "created_at": "2015-03-28T13:26:28-04:00", "email": "bob.norman@hostmail.com", "first_name": "Bob", "id": 207119551, "last_name": "Norman", "last_order_id": 450789469, "multipass_identifier": null, "note": null, "orders_count": 1, "state": "disabled", "total_spent": "41.94", "updated_at": "2015-03-28T13:26:28-04:00", "verified_email": true, "tags": "", "last_order_name": "#1001", "default_address": { "address1": "Chestnut Street 92", "address2": "", "city": "Louisville", "company": null, "country": "United States", "first_name": null, "id": 207119551, "last_name": null, "phone": "555-625-1199", "province": "Kentucky", "zip": "40202", "name": "", "province_code": "KY", "country_code": "US", "country_name": "United States", "default": true } } }, { "buyer_accepts_marketing": false, "cart_token": "68778783ad298f1c80c3bafcddeea02f", "closed_at": null, "completed_at": null, "created_at": "2012-10-12T07:05:27-04:00", "currency": "USD", "email": "bob.norman@hostmail.com", "gateway": "bogus", "id": 642832999, "landing_site": null, "note": null, "referring_site": null, "shipping_lines": [ { "title": "Standard Shipping", "price": "10.99", "code": "Standard Shipping", "source": "haravan" } ], "source_identifier": null, "source_url": null, "subtotal_price": "398.00", "taxes_included": false, "token": "7yjf4v2we7gamku6a6h7tvm8h3mmvs4x", "total_discounts": "39.80", "total_line_items_price": "398.00", "total_price": "379.69", "total_tax": "21.49", "total_weight": 400, "updated_at": "2012-10-12T07:05:27-04:00", "line_items": [ { "applied_discounts": [ ], "compare_at_price": null, "fulfillment_service": "manual", "gift_card": false, "grams": 200, "line_price": "199.00", "price": "199.00", "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", "vendor": "Apple" }, { "applied_discounts": [ ], "compare_at_price": null, "fulfillment_service": "manual", "gift_card": false, "grams": 200, "line_price": "199.00", "price": "199.00", "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", "vendor": "Apple" } ], "name": "#642832999", "note_attributes": [ { "name": "custom engraving", "value": "Happy Birthday" }, { "name": "colour", "value": "green" } ], "source": "anywhere", "discount_codes": [ ], "abandoned_checkout_url": "https:\/\/checkout.local\/690933842\/checkouts\/7yjf4v2we7gamku6a6h7tvm8h3mmvs4x\/recover", "tax_lines": [ { "price": "21.49", "rate": 0.06, "title": "State Tax" } ], "source_name": "anywhere", "billing_address": { "address1": "Chestnut Street 92", "address2": "", "city": "Louisville", "company": null, "country": "United States", "first_name": "Bob", "last_name": "Norman", "latitude": 45.41634, "longitude": -75.6868, "phone": "555-625-1199", "province": "Kentucky", "zip": "40202", "name": "Bob Norman", "country_code": "US", "province_code": "KY" }, "shipping_address": { "address1": "Chestnut Street 92", "address2": "", "city": "Louisville", "company": null, "country": "United States", "first_name": "Bob", "last_name": "Norman", "latitude": 45.41634, "longitude": -75.6868, "phone": "555-625-1199", "province": "Kentucky", "zip": "40202", "name": "Bob Norman", "country_code": "US", "province_code": "KY" }, "customer": { "accepts_marketing": false, "created_at": "2015-03-28T13:26:28-04:00", "email": "bob.norman@hostmail.com", "first_name": "Bob", "id": 207119551, "last_name": "Norman", "last_order_id": 450789469, "multipass_identifier": null, "note": null, "orders_count": 1, "state": "disabled", "total_spent": "41.94", "updated_at": "2015-03-28T13:26:28-04:00", "verified_email": true, "tags": "", "last_order_name": "#1001", "default_address": { "address1": "Chestnut Street 92", "address2": "", "city": "Louisville", "company": null, "country": "United States", "first_name": null, "id": 207119551, "last_name": null, "phone": "555-625-1199", "province": "Kentucky", "zip": "40202", "name": "", "province_code": "KY", "country_code": "US", "country_name": "United States", "default": true } } }, { "buyer_accepts_marketing": false, "cart_token": "68778783ad298f1c80c3bafcddeea02f", "closed_at": null, "completed_at": null, "created_at": "2012-10-12T07:05:27-04:00", "currency": "USD", "email": "bob.norman@hostmail.com", "gateway": "bogus", "id": 1054723303, "landing_site": null, "note": null, "referring_site": null, "shipping_lines": [ { "title": "Free Shipping", "price": "0.00", "code": "Free Shipping", "source": "haravan" } ], "source_identifier": null, "source_url": null, "subtotal_price": "398.00", "taxes_included": false, "token": "exuw7apwoycchjuwtiqg8nytfhphr62a", "total_discounts": "39.80", "total_line_items_price": "398.00", "total_price": "379.69", "total_tax": "21.49", "total_weight": 400, "updated_at": "2012-10-12T07:05:27-04:00", "line_items": [ { "applied_discounts": [ ], "compare_at_price": null, "fulfillment_service": "manual", "gift_card": false, "grams": 200, "line_price": "199.00", "price": "199.00", "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", "vendor": "Apple" }, { "applied_discounts": [ ], "compare_at_price": null, "fulfillment_service": "manual", "gift_card": false, "grams": 200, "line_price": "199.00", "price": "199.00", "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", "vendor": "Apple" } ], "name": "#1054723303", "note_attributes": [ { "name": "custom engraving", "value": "Happy Birthday" }, { "name": "colour", "value": "green" } ], "source": "anywhere", "discount_codes": [ ], "abandoned_checkout_url": "https:\/\/checkout.local\/690933842\/checkouts\/exuw7apwoycchjuwtiqg8nytfhphr62a\/recover", "tax_lines": [ { "price": "21.49", "rate": 0.06, "title": "State Tax" } ], "source_name": "anywhere", "billing_address": { "address1": "Chestnut Street 92", "address2": "", "city": "Louisville", "company": null, "country": "United States", "first_name": "Bob", "last_name": "Norman", "latitude": 45.41634, "longitude": -75.6868, "phone": "555-625-1199", "province": "Kentucky", "zip": "40202", "name": "Bob Norman", "country_code": "US", "province_code": "KY" }, "shipping_address": { "address1": "Chestnut Street 92", "address2": "", "city": "Louisville", "company": null, "country": "United States", "first_name": "Bob", "last_name": "Norman", "latitude": 45.41634, "longitude": -75.6868, "phone": "555-625-1199", "province": "Kentucky", "zip": "40202", "name": "Bob Norman", "country_code": "US", "province_code": "KY" }, "customer": { "accepts_marketing": false, "created_at": "2015-03-28T13:26:28-04:00", "email": "bob.norman@hostmail.com", "first_name": "Bob", "id": 207119551, "last_name": "Norman", "last_order_id": 450789469, "multipass_identifier": null, "note": null, "orders_count": 1, "state": "disabled", "total_spent": "41.94", "updated_at": "2015-03-28T13:26:28-04:00", "verified_email": true, "tags": "", "last_order_name": "#1001", "default_address": { "address1": "Chestnut Street 92", "address2": "", "city": "Louisville", "company": null, "country": "United States", "first_name": null, "id": 207119551, "last_name": null, "phone": "555-625-1199", "province": "Kentucky", "zip": "40202", "name": "", "province_code": "KY", "country_code": "US", "country_name": "United States", "default": true } } } ] }