Introduction to Checkout
The Checkout API makes it possible to purchase products from a Zoho Commerce store programmatically. A checkout in Zoho Commerce is the Object used to manage a customerʼs cart as it transitions to a paid checkout. This includes calculating taxes, shipping rates, attaching the customerʼs information, and finally completing a purchase by submitting a payment. Use this API if you want a fully customized checkout user experience, while taking full advantage of the commerce engine used to power every store in Zoho Commerce.
Parameters
| Parameter | Description |
| checkout_id | string: Unique ID generated by the server for the checkout. This is used as an identifier. |
| address_detail | object: An object containing arrays |
| * addresses - list of saved addresses for a customer | |
| * countries - list of countries and their respective states for which shipping is supported. | |
| addresses | |
| full_name | string: Full name of the customer |
| id | long: A unique identifier generated by the server for the address |
| is_selected | boolean: A Boolean to denote whether the address is selected |
| address | string: Shipping address of the customer |
| city | string: Name of the city |
| state_name | string: Name of the state |
| postal_code | string: ZIP Code of the address |
| country_name | string: Name of the country |
| telephone | string: Phone number |
| countries | |
| code | string: Two letter code of the country |
| name | string: Name of the country |
| states | array: List of states for which shipping is supported |
| states | |
| code | string: Two letter code of the state |
| name | string: Name of the state |
| org_meta | object: Meta information of the organization |
| org_version | string: Edition of the organization |
| currency | object: Contains the currency information of the checkout |
| symbol | string: Symbol of the currency |
| code | string: Currency code |
| symbol_formatted | string: Formatted symbol of the currency |
| code_on_left | boolean: Denotes whether the currency code is on the left |
| symbol_on_left | boolean: Denotes whether the currency symbol is on the left |
| format | string: Format of the currency |
| completed_tasks | object: Contains the status of the tasks in checkout |
| portal | boolean: Denotes whether login is complete |
| address_detail | boolean: Denotes whether address details have been filled |
| shipping_methods | boolean: Denotes whether a shipping method has been chosen |
| order | boolean: Denotes whether an order has been placed |
| portal | object: Contains the member portal information of the checkout |
| logout_url | string: URL for logging out from the member portal |
| is_guest_enabled | boolean: Denotes whether guest checkouts are allowed |
| login_url | string: URL for logging into the member portal |
| is_portal_enabled | boolean: Denotes whether member portal is enabled for the store |
| signup_url | string: URL for signup to the member portal |
| user | object: Contains the user details in the checkout |
| user | object: An object containing the user details in the checkout |
| email_id | string: The email ID of the customer checking out |
| is_guest | boolean: Denotes whether the customer is part of the portal |
| telephone | string: Phone number of the customer |
| shipping_methods | array: Array of shipping methods available for the address |
| id | string: Unique identifier of the shipping method |
| delivery_time | string: The delivery time of the shipping method |
| is_default | boolean: Denotes whether the shipping method is default |
| name | string: Name of the shipping method |
| rate | double: The shipping charge for the shipping method |
| handling_fees | double: Additional handling fees for the shipping method |
| order | object: An object containing the order information in the checkout |
| tax_amount | double: The total tax applied on the order |
| is_tax_inclusive | boolean: Denotes whether the prices in the checkout include taxes |
| payment_url | string: URL for performing online payments |
| coupon | object: Contains the coupon information for the store |
| is_enabled | boolean: Denotes whether coupons are enabled for the store |
| discount_amount | double: The total discount applied on the order |
| shipping_amount | double: The shipping charge applied on the order |
| total | double: The total amount to be paid for the order |
| sub_total | double: The sub total of the order |
| is_offline_payment_eligible | boolean: Denotes whether offline payments are eligible |
| is_online_payment_configured | boolean: Denotes whether online payments are configured |
| cart_url | string: URL for the cart page of the store |
| shop_url | string: URL for the home page of the store |
| allow_order_notes_in_checkout | boolean: Denotes whether order notes are allowed in checkout |
| offline_payments | array: Contains the configured offline payments |
| cart | object: Contains the cart information of the checkout |
| taxes | array: Contains the tax information of the checkout |
| offline_payments | array: Contains the configured offline payments |
| label | string: Label to be used for display |
| label_formatted | string: Formatted label to be used for display |
| payment_mode | string: The payment mode to be used for offline payments |
| payment_mode_formatted | string: Formatted value of payment mode |
| minimum_order_amount | double: The minimum order value eligible for offline payments |
| maximum_order_amount | double: The maximum order value eligible for offline payments |
| instruction | string: The instruction to be displayed to the customer |
| instruction_formatted | string: Formatted value of the instruction |
| additional_charges | double: Additional charges to be applied for offline payments |
| additional_charges_formatted | double: Formatted value for the additional charges |
| total | double: Total value of the order for offline payments |
| cart | object: Contains the cart information of the checkout |
| cart_id | string: Unique identifier of the cart |
| checkout_url | string: URL for the checkout in the store |
| total_price | double: Total price of the cart |
| count | int: Count of the items in the cart |
| items | array: Contains the list of items in the cart |
| items | array: Contains the list of items in the car |
| selling_price | double: Selling price of the item |
| quantity | int: Quantity of the item |
| total_price | double: Total price of the item |
| discount_amount | double: Discount applied on the item |
| custom_fields | array: Contains the custom fields mapped to the item |
| description | string: Description of the item |
| is_out_of_stock | boolean: Denotes whether the item is out of stock |
| label_price | double: Label price of the item |
| stock_available | int: The available stock of the item |
| url | string: The URL of the product in the store |
| approximate_total | double: The approximate total of the item |
| variant_id | string: The unique identifier of the variant |
| name | string: The name of the item |
| options | array: Variant details (name, ID and value of the attribute) |
| is_returnable | boolean: Denotes whether the item is returnable |
| sku | string: SKU of the item |
| images | array: Contains the images of the items |
| images | array: Contains the images of the items |
| id | string: Unique identifier of the image |
| title | string: Title of the image |
| url | string: URL of the image in the store |
| order | int: Order of the image |
| is_featured | boolean: Denotes whether the image is featured |
| is_placeholder_image | boolean: Denotes whether the image is a placeholder image |
| alternate_text | string: The alt text to be used for the image |