BlueCart · Schema
OrderUpdate
Payload for modifying an existing order.
RestaurantProcurementWholesaleOrderingFood DistributionHospitalityeCommerce
Properties
| Name | Type | Description |
|---|---|---|
| userId | integer | Identifier of the user making the change. |
| status | string | New order status. |
| deliveryCharge | number | Updated delivery charge. |
| requestedDeliveryDate | string | |
| deliveryDate | string | |
| shippingDate | string | |
| paymentStatus | string | Payment status for the order. |
| trackingInfo | string | Shipment tracking information. |
| addresses | object | |
| products | array |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "OrderUpdate",
"description": "Payload for modifying an existing order.",
"$id": "https://raw.githubusercontent.com/api-evangelist/bluecart/refs/heads/main/json-schema/bluecart-order-update-schema.json",
"type": "object",
"properties": {
"userId": {
"type": "integer",
"format": "int64",
"description": "Identifier of the user making the change.",
"example": 3001
},
"status": {
"type": "string",
"description": "New order status.",
"enum": [
"New",
"Processing",
"In-Transit/Shipped",
"Fulfilled",
"Cancelled"
],
"example": "Processing"
},
"deliveryCharge": {
"type": "number",
"format": "float",
"description": "Updated delivery charge.",
"example": 25
},
"requestedDeliveryDate": {
"type": "string",
"format": "date",
"example": "2026-06-10"
},
"deliveryDate": {
"type": "string",
"format": "date",
"example": "2026-06-10"
},
"shippingDate": {
"type": "string",
"format": "date",
"example": "2026-06-09"
},
"paymentStatus": {
"type": "string",
"description": "Payment status for the order.",
"example": "Paid"
},
"trackingInfo": {
"type": "string",
"description": "Shipment tracking information.",
"example": "1Z999AA10123456784"
},
"addresses": {
"type": "object",
"additionalProperties": true
},
"products": {
"type": "array",
"items": {
"title": "OrderProduct",
"type": "object",
"description": "A line item within an order.",
"x-schema-source": "documentation",
"x-source-url": "https://docs.bluecart.com/endpoints",
"properties": {
"productId": {
"type": "integer",
"format": "int64",
"description": "Identifier of the product.",
"example": 90210
},
"sku": {
"type": "string",
"description": "Stock keeping unit of the product.",
"example": "WINE-CAB-750"
},
"name": {
"type": "string",
"description": "Product name.",
"example": "Cabernet Sauvignon 750ml"
},
"quantity": {
"type": "number",
"description": "Quantity ordered.",
"example": 12
},
"price": {
"type": "number",
"format": "float",
"description": "Unit price for this line item.",
"example": 18.5
}
}
}
}
}
}