Historical contract: Clear Cart
Historical API contract. This page describes an earlier API contract. Methods, paths, and responses may differ from the current API.
Historical meaning
Clear Cart
This API endpoint is used to clean the whole cart
Current API
For new integrations, use the linked current API reference or guide.
View the current API referenceParameters
[
{
"name": "language",
"in": "path",
"schema": {
"type": "string",
"default": "en"
},
"required": true
},
{
"name": "project",
"in": "path",
"schema": {
"type": "string",
"default": "<redacted-personal>"
},
"required": true
},
{
"name": "api_version",
"in": "path",
"schema": {
"type": "string",
"default": "v400"
},
"required": true
}
]
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "Identifier of the cart"
}
}
}
}
}
}
Responses
{
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": false,\n \"result\": {\n \"uuid\": \"<redacted-secret>\",\n \"user_id\": 0,\n \"status\": 0,\n \"business_id\": 0,\n \"comment\": null,\n \"driver_tip_rate\": 0,\n \"paymethod_id\": null,\n \"driver_tip\": 0,\n \"quantity\": 0,\n \"paymethod_data\": null,\n \"products\": [],\n \"business\": {\n \"name\": \"<redacted-personal>\",\n \"slug\": \"wine\",\n \"logo\": \"https://example.com/ordering-images2/res/ordering/image/upload/cydr01phh92gbcnmf8d7/1534194674.jpg\",\n \"header\": \"https://example.com/ordering2/image/upload/v1612896387/nhpzowjwijuhmxx8p9vu.jpg\",\n \"service_fee\": 1,\n \"tax_type\": 2,\n \"tax\": 2,\n \"currency\": \"USD\",\n \"delivery_time\": \"1:0\",\n \"pickup_time\": \"2:1\"\n },\n \"metafields\": [],\n \"subtotal\": 0,\n \"valid_address\": true,\n \"delivery_zone_id\": 2,\n \"delivery_price\": 2,\n \"minimum\": 1,\n \"valid_minimum\": false,\n \"valid_maximum\": true,\n \"maximum\": null,\n \"valid_schedule\": true,\n \"valid_products\": false,\n \"valid\": false,\n \"tax_rate\": 2,\n \"service_fee_rate\": 1,\n \"service_fee\": 0,\n \"tax\": 0,\n \"tax_with_discount\": 0,\n \"discount\": 0,\n \"offers\": [],\n \"subtotal_with_discount\": 0,\n \"service_fee_with_discount\": 0,\n \"delivery_price_with_discount\": 2,\n \"total\": 2\n }\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": false,
"default": true
},
"result": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"example": "<redacted-secret>"
},
"user_id": {
"type": "integer",
"example": 0,
"default": 0
},
"status": {
"type": "integer",
"example": 0,
"default": 0
},
"business_id": {
"type": "integer",
"example": 0,
"default": 0
},
"comment": {},
"driver_tip_rate": {
"type": "integer",
"example": 0,
"default": 0
},
"paymethod_id": {},
"driver_tip": {
"type": "integer",
"example": 0,
"default": 0
},
"quantity": {
"type": "integer",
"example": 0,
"default": 0
},
"paymethod_data": {},
"products": {
"type": "array"
},
"business": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"slug": {
"type": "string",
"example": "wine"
},
"logo": {
"type": "string",
"example": "https://example.com/ordering-images2/res/ordering/image/upload/cydr01phh92gbcnmf8d7/1534194674.jpg"
},
"header": {
"type": "string",
"example": "https://example.com/ordering2/image/upload/v1612896387/nhpzowjwijuhmxx8p9vu.jpg"
},
"service_fee": {
"type": "integer",
"example": 1,
"default": 0
},
"tax_type": {
"type": "integer",
"example": 2,
"default": 0
},
"tax": {
"type": "integer",
"example": 2,
"default": 0
},
"currency": {
"type": "string",
"example": "USD"
},
"delivery_time": {
"type": "string",
"example": "1:0"
},
"pickup_time": {
"type": "string",
"example": "2:1"
}
}
},
"metafields": {
"type": "array"
},
"subtotal": {
"type": "integer",
"example": 0,
"default": 0
},
"valid_address": {
"type": "boolean",
"example": true,
"default": true
},
"delivery_zone_id": {
"type": "integer",
"example": 2,
"default": 0
},
"delivery_price": {
"type": "integer",
"example": 2,
"default": 0
},
"minimum": {
"type": "integer",
"example": 1,
"default": 0
},
"valid_minimum": {
"type": "boolean",
"example": false,
"default": true
},
"valid_maximum": {
"type": "boolean",
"example": true,
"default": true
},
"maximum": {},
"valid_schedule": {
"type": "boolean",
"example": true,
"default": true
},
"valid_products": {
"type": "boolean",
"example": false,
"default": true
},
"valid": {
"type": "boolean",
"example": false,
"default": true
},
"tax_rate": {
"type": "integer",
"example": 2,
"default": 0
},
"service_fee_rate": {
"type": "integer",
"example": 1,
"default": 0
},
"service_fee": {
"type": "integer",
"example": 0,
"default": 0
},
"tax": {
"type": "integer",
"example": 0,
"default": 0
},
"tax_with_discount": {
"type": "integer",
"example": 0,
"default": 0
},
"discount": {
"type": "integer",
"example": 0,
"default": 0
},
"offers": {
"type": "array"
},
"subtotal_with_discount": {
"type": "integer",
"example": 0,
"default": 0
},
"service_fee_with_discount": {
"type": "integer",
"example": 0,
"default": 0
},
"delivery_price_with_discount": {
"type": "integer",
"example": 2,
"default": 0
},
"total": {
"type": "integer",
"example": 2,
"default": 0
}
}
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
}
}