Add Address
HTTP Request
POST https://commerce.zoho.com/storefront/api/v1/checkout/address
Parameters
| Parameter | Description |
| checkout_id* | string: Unique ID generated by the server for the checkout. This is used as an identifier. |
Body Parameters
| Parameter | Description |
| shipping_address* | object: The address to which the goods must be delivered. |
| first_name | string: First name of the customer's shipping/billing. |
| last_name | string: Last name of the customer's shipping/billing. |
| email_address | string: Email Id of the customer's shipping/billing address. |
| state | string: State of the customer's shipping/billing address. |
| postal_code | string: ZIP Code of the customer's shipping/billing address. |
| telephone | string: Phone number of the customer's shipping/billing address. |
| country | string: Country of the customer's shipping/billing address. |
| same_billing_address | boolean: Checks whether the billing address is the same as shipping address. |
| billing_address* | string: Billing address of the customer (contains the same fields as above). |
Note: To add a saved address (In case of a portal user) to the checkout, pass the 'address_id' in the payload.
Request Example
Copiedcurl -i -L -X POST
-H "domain-name:zylkerfashionstore.zohostore.com"
-H "X-ZCSRF-TOKEN:csrfp=601e2933-497c-437a-96b3-ed9cf8b4644e"
-H "Cookie:zcid=2-23b9d1185b4624301728dd3e93c851b28edd27106b7d75ded779884d08a68b1f9b06f2b2570d33b34f0c01e74040f8bc; "
-H "Content-Type:application/json"
-d
'{"shipping_address":
{"first_name":"Jane",
"last_name":"Doe",
"email_address":"janedoe@zoho.com",
"address":"777 STORY RD",
"city":"SAN JOSE",
"state":"CA",
"postal_code":"95122-2628",
"telephone":"4088851142",
"same_billing_address":true,
"country":"US"
},
"billing_address":
{"first_name":"Jane",
"last_name":"Doe",
"email_address":"janedoe@zoho.com",
"address":"777 STORY RD",
"city":"SAN JOSE",
"state":"CA",
"postal_code":"95122-2628",
"telephone":"4088851142",
"same_billing_address":true,
"country":"US"
}
}'
'https://commerce.zoho.com/storefront/api/v1/checkout/address?checkout_id=2-23b9d1185b4624301728dd3e93c851b28edd27106b7d75ded779884d08a68b1f9b06f2b2570d3
Show full
Show less
Success Response
Copied{
"status_message": "success",
"status_code": "0",
"payload": {
"checkout_shipping_methods": {
"shipping_methods": [
{
"handling_fees": 0,
"rate": 10,
"name": "Free",
"id": "1706707000000069645",
"delivery_time": "3 business days",
"is_default": false
}
],
"currency": {
"symbol": "$",
"code": "USD",
"symbol_formatted": "$",
"code_on_left": true,
"format": "###,##0.00",
"symbol_on_left": true
}
},
"checkout_order_summary": {
"org_meta": {
"org_version": "us"
},
"currency": {
"symbol": "$",
"code": "USD",
"symbol_formatted": "$",
"code_on_left": true,
"format": "###,##0.00",
"symbol_on_left": true
},
"order": {
"tax_amount": 13.81,
"is_tax_inclusive": true,
"payment_url": "https://zohosecurepay.com/cart/2-23b9d1185b4624301728dd3e93c851b28edd27106b7d75ded779884d08a68b1f9b06f2b2570d33b34f0c01e74
"coupon": {
"is_enabled": true
},
"discount_amount": 0,
"taxes": [
{
"is_inclusive": false,
"amount": 13.81,
"name": "gst (5%)"
}
],
"billing_address": {
"country": "US",
"address": "777 STORY RD",
"city": "SAN JOSE",
"is_selected_billing_address": false,
"is_selected": false,
"last_name": "Doe",
"telephone": "4088851142",
"full_name": "Jane Doe",
"email_address": "janedoe@zoho.com",
"state_name": "California",
"same_billing_address": true,
"country_name": "U.S.A",
"state": "CA",
"postal_code": "95122-2628",
"first_name": "Jane"
},
"cart": {
"cart_id": "2-23b9d1185b4624301728dd3e93c851b28edd27106b7d75ded779884d08a68b1f9b06f2b2570d33b34f0c01e74040f8bc",
"checkout_url": "/checkout",
"total_price": 276.19,
"count": 1,
"items": [
{
"selling_price": 290,
"images": [
{
"alternate_text": "Little Black Dress",
"is_placeholder_image": false,
"id": "1706707000000069483",
"title": "Little Black Dress",
"url": "/product-images/1706707000000069483",
"is_featured": true,
"order": 0
}
],
"quantity": 1,
"total_price": 276.19,
"discount_amount": 0,
"custom_fields": [
{
"customfield_id": "1706707000000490001",
"display_value": "Test note",
"values": [
],
"index": 0,
"is_mandatory": false,
"label": "Include a note for us",
"is_enabled": false,
"edit_on_store": false,
"options": [
],
"show_in_pdf": false,
"show_in_storefront": false,
"field_type": "string",
"value": "Test note"
}
],
"description": "",
"is_out_of_stock": false,
"label_price": 0,
"stock_available": 0,
"url": "/products/1706707000000068713?variant=1706707000000068709",
"approximate_total": 290,
"variant_id": "1706707000000068709",
"name": "Little Black Dress-2",
"options": [
{
"name": "Size",
"id": "0",
"value": "2",
"color_code": ""
}
],
"is_returnable": false,
"sku": ""
}
]
},
"shipping_amount": 0,
"total": 290,
"offline_payments": [
{
"label_formatted": "Cash on Delivery",
"payment_mode": "cash_on_delivery",
"total": 290,
"payment_mode_formatted": "Cash on Delivery",
"instruction_formatted": "",
"additional_charges": 0,
"instruction": "",
"label": "Cash on Delivery",
"maximum_order_amount": 10000,
"additional_charges_formatted": "$0.00",
"minimum_order_amount": 10
}
],
"terms": {
"is_enabled": false,
"label": "",
"url": ""
},
"shop_url": "/",
"is_offline_payment_eligible": true,
"sub_total": 276.19,
"cart_url": "/cart?cart_id=2-23b9d1185b4624301728dd3e93c851b28edd27106b7d75ded779884d08a68b1f9b06f2b2570d33b34f0c01e74040f8bc",
"allow_order_notes_in_checkout": false,
"is_online_payment_configured": false,
"shipping_address": {
"country": "US",
"address": "777 STORY RD",
"city": "SAN JOSE",
"is_selected_billing_address": false,
"is_selected": false,
"last_name": "Doe",
"telephone": "4088851142",
"full_name": "Jane Doe",
"email_address": "janedoe@zoho.com",
"state_name": "California",
"same_billing_address": true,
"country_name": "U.S.A",
"state": "CA",
"postal_code": "95122-2628",
"first_name": "Jane"
}
}
}
},
"api_kind": "kind#checkout-address"
}Show full
Show less
Failure Response
Copied{
"status_message": "failure",
"status_code": "1",
"api_kind": "kind#checkout-address",
"error": {
"code": 253921,
"message": "There are no shipping methods available for this order.Please get in touch with us for more details."
}
}