Cart Checkout
Checkout will begin the process of transforming the cart indicated by the cart_id parameter it into a SubscriptionOrder and create one or more DropShipPurchaseOrders.
When the API returns a 200 response the carts status will be updated to checkout_in_progress and this will kick off a asynchronous process to complete placing the order. Typically there are several additional asynchronous steps required to complete the checkout process.
Merchants can poll the Show Cart API to check the status of the cart. Once the asynchronous process is complete the cart status will be updated to checkout_complete or checkout_failed. When successful, Merchants should begin their internal fulfillment process for the order.
The cart_id and merchant_order_id parameters are required. The merchant_order_id is the merchant's unique identifier for the order. The provided merchant_order_id will allow the merchant to find associated DropShipPurchaseOrders via the GET /drop_ship_purchase_orders api.
The merchant_order_id must be unique for the each successful cart checkout. If the merchant provides a duplicate merchant_order_id the API will return a 409 Conflict error.
Merchants should verify the cart's can_checkout attribute is true before calling checkout. If the cart is not ready to checkout the API will return a 409 error.
Request
- Base URLhttps://api.liftforward.com
- AuthAPI key in header Api-Key
Path parameters
Request body
Example request
{
"cart": {
"merchant_order_id": "2xkgcyphn76fj2tkswq78qm5d3r"
}
}Response
Cart Checkout
Example response
{
"cart": {
"cart_id": "rknvt6atnp72x7x4dy2c34rh3hw",
"merchant_customer_id": "8c8k2jhzaq46pbjpd5bp9m59z5b",
"merchant": {
"source_channel_id": "ONLINE_SHIP_TO_HOME",
"store_id": "3028478594",
"employee_id": "39383473893939",
"merchant_metadata": {
"custom_key_1": "custom_value_1",
"custom_key_2": "custom_value_2"
}
},
"country_code": "US",
"created_at": "2021-08-13T20:30:59Z",
"currency": "USD",
"total_sale_price": 1259.99,
"total_price": 1366.49,
"total_sales_tax": 106.5,
"total_installment_payment": 56.94,
"status": "checkout_complete",
"compliance_errors": [
{
"key": "over_limit",
"type": "over_limit"
}
],
"sales_tax_rates": [
{
"sales_tax_rate_code": "VAT",
"rate": 0.0875,
"amount": 26.25
}
],
"rental_items": [
{
"cart_item_id": "4sbfbsrnqkax7sc77n27shmb54n",
"product_id": "snzqb89yamhaqexyrkmj5j773fn",
"product_name": "Super cool product",
"merchant_sku": "SUPER-PRODUCT-123",
"unit_retail_price": 350,
"unit_sale_price": 350,
"total_payment_to_buy_out": 2030,
"total_payment_to_trade_in": 2030,
"unit_installment_payment": 9.91,
"installment_service_fee": 9.95,
"total_installment_service_fee": 9.95,
"currency": "USD",
"installment_count": 36,
"cart_max_quantity": 1,
"inventory_message": "Available Now",
"inventory_help_message": "Available Now",
"contract_type": "FINANCING",
"residual_value_category": "iPhone 16",
"sales_tax_rates": [
{
"sales_tax_rate_code": "VAT",
"rate": 0.0875,
"amount": 26.25
}
],
"linked_service_item_ids": [
"v2a74msban4wbcn738fta6j67rt"
],
"linked_cart_item_ids": [
"t7tq5tnesgcxd85vgbd3egg847s"
],
"subscription_plan": {
"subscription_plan_id": "standard-plan-30",
"program_code": "subscription-us",
"plan_code": "standard",
"plan_name": "Standard Plan",
"plan_subtitle": "This is the basic plan.",
"plan_summary": "Total financed amount when you upgrade is $2,090 and includes 25 months of payments. T&Cs, fees, charges & exclusions apply.",
"financing_plan_type": "financing"
}
}
],
"finance_items": [
{
"cart_item_id": "4sbfbsrnqkax7sc77n27shmb54n",
"product_id": "snzqb89yamhaqexyrkmj5j773fn",
"product_name": "Super cool product",
"merchant_sku": "SUPER-PRODUCT-123",
"unit_retail_price": 350,
"unit_sale_price": 350,
"total_payment_to_buy_out": 2030,
"total_payment_to_trade_in": 2030,
"unit_installment_payment": 9.91,
"installment_service_fee": 9.95,
"total_installment_service_fee": 9.95,
"currency": "USD",
"installment_count": 36,
"cart_max_quantity": 1,
"inventory_message": "Available Now",
"inventory_help_message": "Available Now",
"contract_type": "FINANCING",
"residual_value_category": "iPhone 16",
"sales_tax_rates": [
{
"sales_tax_rate_code": "VAT",
"rate": 0.0875,
"amount": 26.25
}
],
"linked_service_item_ids": [
"v2a74msban4wbcn738fta6j67rt"
],
"linked_cart_item_ids": [
"t7tq5tnesgcxd85vgbd3egg847s"
],
"subscription_plan": {
"subscription_plan_id": "standard-plan-30",
"program_code": "subscription-us",
"plan_code": "standard",
"plan_name": "Standard Plan",
"plan_subtitle": "This is the basic plan.",
"plan_summary": "Total financed amount when you upgrade is $2,090 and includes 25 months of payments. T&Cs, fees, charges & exclusions apply.",
"financing_plan_type": "financing"
}
}
],
"service_items": [
{
"cart_item_id": "4sbfbsrnqkax7sc77n27shmb54n",
"product_id": "snzqb89yamhaqexyrkmj5j773fn",
"product_name": "Super cool product",
"merchant_sku": "SUPER-PRODUCT-123",
"unit_retail_price": 350,
"unit_sale_price": 350,
"total_payment_to_buy_out": 2030,
"total_payment_to_trade_in": 2030,
"unit_installment_payment": 9.91,
"installment_service_fee": 9.95,
"total_installment_service_fee": 9.95,
"currency": "USD",
"installment_count": 36,
"cart_max_quantity": 1,
"inventory_message": "Available Now",
"inventory_help_message": "Available Now",
"contract_type": "FINANCING",
"residual_value_category": "iPhone 16",
"sales_tax_rates": [
{
"sales_tax_rate_code": "VAT",
"rate": 0.0875,
"amount": 26.25
}
],
"linked_service_item_ids": [
"v2a74msban4wbcn738fta6j67rt"
],
"linked_cart_item_ids": [
"t7tq5tnesgcxd85vgbd3egg847s"
],
"subscription_plan": {
"subscription_plan_id": "standard-plan-30",
"program_code": "subscription-us",
"plan_code": "standard",
"plan_name": "Standard Plan",
"plan_subtitle": "This is the basic plan.",
"plan_summary": "Total financed amount when you upgrade is $2,090 and includes 25 months of payments. T&Cs, fees, charges & exclusions apply.",
"financing_plan_type": "financing"
}
}
]
}
}Changes
No recorded changes to this operation across all 8 revisions of this API.