Commerce Engine is now in beta. We're working hard to make it better for you.
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/pos/fulfillment-options \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cart_id": "<string>",
"fulfillment_type": "delivery"
}
'{
"message": "<string>",
"success": true,
"content": {
"summary": {
"collect_available": true,
"deliver_available": true,
"recommended_fulfillment_type": "collect-in-store",
"recommended_store": {
"id": "<string>",
"name": "<string>",
"distance_km": 123,
"collect_eta_minutes": 123,
"is_recommended": true,
"address": {
"name": "<string>",
"address_line1": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"country_code": "+91",
"address_line2": "<string>",
"landmark": "<string>"
}
}
},
"collect": [
{
"id": "<string>",
"name": "<string>",
"distance_km": 123,
"collect_eta_minutes": 123,
"is_recommended": true,
"address": {
"name": "<string>",
"address_line1": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"country_code": "+91",
"address_line2": "<string>",
"landmark": "<string>"
}
}
],
"deliver": {
"is_serviceable": true,
"shipments": [
{
"id": "<string>",
"items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"variant_id": "<string>",
"variant_name": "<string>",
"sku": "<string>",
"quantity": 123,
"free_quantity": 123,
"is_free_item": true
}
],
"shipping_methods": [
{
"id": "<string>",
"name": "<string>",
"shipping_type": "auto",
"shipping_amount": "<string>",
"estimated_delivery_days": "<string>",
"courier_companies": [
{
"id": "<string>",
"name": "<string>",
"shipping_amount": 123,
"estimated_delivery_days": "<string>",
"is_recommended": true,
"is_hyperlocal": true,
"mode": "air",
"rating": 123
}
]
}
]
}
]
}
}
}This endpoint returns the available fulfillment options for a given cart and delivery pincode. It provides both delivery options and collect-in-store (Click & Collect) options, including details of store locations where the item can be collected.
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/pos/fulfillment-options \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cart_id": "<string>",
"fulfillment_type": "delivery"
}
'{
"message": "<string>",
"success": true,
"content": {
"summary": {
"collect_available": true,
"deliver_available": true,
"recommended_fulfillment_type": "collect-in-store",
"recommended_store": {
"id": "<string>",
"name": "<string>",
"distance_km": 123,
"collect_eta_minutes": 123,
"is_recommended": true,
"address": {
"name": "<string>",
"address_line1": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"country_code": "+91",
"address_line2": "<string>",
"landmark": "<string>"
}
}
},
"collect": [
{
"id": "<string>",
"name": "<string>",
"distance_km": 123,
"collect_eta_minutes": 123,
"is_recommended": true,
"address": {
"name": "<string>",
"address_line1": "<string>",
"pincode": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"country_code": "+91",
"address_line2": "<string>",
"landmark": "<string>"
}
}
],
"deliver": {
"is_serviceable": true,
"shipments": [
{
"id": "<string>",
"items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"variant_id": "<string>",
"variant_name": "<string>",
"sku": "<string>",
"quantity": 123,
"free_quantity": 123,
"is_free_item": true
}
],
"shipping_methods": [
{
"id": "<string>",
"name": "<string>",
"shipping_type": "auto",
"shipping_amount": "<string>",
"estimated_delivery_days": "<string>",
"courier_companies": [
{
"id": "<string>",
"name": "<string>",
"shipping_amount": 123,
"estimated_delivery_days": "<string>",
"is_recommended": true,
"is_hyperlocal": true,
"mode": "air",
"rating": 123
}
]
}
]
}
]
}
}
}Was this page helpful?