--- updatedAt: 2026-07-28T13:49:18.000Z agentTools: projectIndex: https://kitchenhub.readme.io/llms.txt --- # Get all deliveries Retrieve list of deliveries # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "API reference", "description": "swagger ui demo.", "version": "1.0" }, "servers": [ { "url": "https://api.kitchenhub.app", "description": "KitchenHub API url" } ], "paths": { "/v2/deliveries/": { "get": { "tags": [ "Deliveries" ], "summary": "Get all deliveries", "description": "Retrieve list of deliveries", "parameters": [ { "name": "store_id", "in": "query", "description": "", "required": false, "schema": { "title": "store_id", "type": "string" } }, { "name": "partner_store_id", "in": "query", "description": "", "required": false, "schema": { "title": "partner_store_id", "type": "string" } }, { "name": "date_from", "in": "query", "description": "", "required": false, "schema": { "title": "date_from", "type": "string" } }, { "name": "date_to", "in": "query", "description": "", "required": false, "schema": { "title": "date_to", "type": "string" } }, { "name": "status", "in": "query", "description": "", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "order_id", "in": "query", "description": "Filter by a specific order ID (can be anything)", "required": false, "schema": { "title": "order_id", "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveriesResponseSerializer" } } }, "links": {} }, "401": { "description": "Unauthorized", "content": { "application/json": {} }, "links": {} }, "403": { "description": "Forbidden", "content": { "application/json": {} }, "links": {} }, "422": { "description": "Validation error", "content": { "application/json": {} }, "links": {} }, "424": { "description": "Error on provider side. Please try again later", "content": { "application/json": {} }, "links": {} }, "500": { "description": "Technical error. Please contact support to resolve this issue", "content": { "application/json": {} }, "links": {} }, "501": { "description": "Provider is not supported or not implemented yet", "content": { "application/json": {} }, "links": {} } }, "deprecated": false, "security": [ { "apiKeyAuth": [] } ] } } }, "components": { "schemas": { "ms_api__dtos__delivery__CustomerInfoSerializer": { "title": "CustomerInfoSerializer", "type": "object", "properties": { "first_name": { "title": "First Name", "description": "The customer's first name.", "type": "string" }, "last_name": { "title": "Last Name", "description": "The customer's last name.", "type": "string" }, "phone_number": { "title": "Phone Number", "description": "The customer's contact phone number.", "type": "string" }, "email": { "title": "Email", "description": "The customer's email address.", "type": "string" } }, "required": [ "first_name", "last_name" ] }, "ms_api__dtos__delivery__ChargesSerializer": { "title": "ChargesSerializer", "type": "object", "properties": { "total": { "title": "Total", "description": "The total amount to be paid.", "type": "number" }, "delivery_fee": { "title": "Delivery Fee", "description": "The fee for the delivery service.", "type": "number" }, "delivery_tips": { "title": "Delivery Tips", "description": "The tips given to the delivery person.", "type": "number" }, "subtotal": { "title": "Subtotal", "description": "The subtotal amount.", "type": "number" } }, "required": [ "total" ] }, "DeliveryItemDTO": { "title": "DeliveryItemDTO", "type": "object", "properties": { "name": { "title": "Name", "description": "The name of the item.", "type": "string" }, "quantity": { "title": "Quantity", "description": "The quantity of the item.", "type": "integer" }, "price": { "title": "Price", "description": "The price of the item.", "type": "number" }, "is_alcohol": { "title": "Is alcohol", "description": "Flag indicates that item contain alcohol", "default": false, "type": "boolean" } }, "required": [ "name", "quantity", "price" ] }, "DeliveryStatus": { "title": "DeliveryStatus", "description": "An enumeration.", "enum": [ "new", "placed", "enroute", "arrived", "delivered", "cancelled", "returned" ], "type": "string" }, "ms_api__dtos__delivery__PickupInfo": { "title": "PickupInfo", "type": "object", "properties": { "restaurant_name": { "title": "Restaurant Name", "description": "The name of the restaurant where the order will be picked up.", "type": "string" }, "restaurant_address": { "title": "Restaurant Address", "description": "The complete address of the restaurant for pickup location.", "type": "string" }, "pickup_datetime": { "title": "Pickup Date and Time", "description": "The scheduled date and time for picking up the order from the restaurant.", "type": "string", "format": "date-time" }, "pickup_notes": { "title": "Pickup Notes", "description": "Any special instructions or notes related to the pickup.", "type": "string" }, "pickup_time_estimated": { "title": "Estimated Pickup Time", "description": "The estimated time when the order will be ready for pickup.", "type": "string", "format": "date-time" } }, "required": [ "restaurant_name", "restaurant_address" ] }, "ms_api__dtos__delivery__DropOffInfo": { "title": "DropOffInfo", "type": "object", "properties": { "drop_off_address": { "title": "Drop Off Address", "description": "The address where the order will be delivered.", "type": "string" }, "drop_off_datetime": { "title": "Drop Off Date and Time", "description": "The scheduled date and time for the drop-off at the delivery location.", "type": "string", "format": "date-time" }, "drop_off_notes": { "title": "Drop Off Notes", "description": "Any special instructions or notes related to the drop-off.", "type": "string" }, "dropoff_time_estimated": { "title": "Estimated Drop Off Time", "description": "The estimated time when the order will be delivered.", "type": "string", "format": "date-time" } }, "required": [ "drop_off_address" ] }, "DeliveryServiceEnum": { "title": "DeliveryServiceEnum", "description": "An enumeration.", "enum": [ "delivery_logic", "delivery_logic_marketplace", "doordash_drive", "cartwheel" ], "type": "string" }, "CourierInfoSerializer": { "title": "CourierInfoSerializer", "type": "object", "properties": { "id": { "title": "Courier ID", "description": "The unique identifier for the courier assigned to this delivery.", "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "name": { "title": "Courier Name", "description": "The name of the courier.", "type": "string" }, "phone_number": { "title": "Courier Phone Number", "description": "The contact phone number of the courier.", "type": "string" }, "phone_code": { "title": "Courier Phone Code", "description": "The international dialing code for the courier's phone number.", "type": "string" }, "photo_url": { "title": "Courier Photo URL", "description": "A URL to the courier's photo.", "type": "string" }, "vehicle_type": { "title": "Courier Vehicle Type", "description": "The type of vehicle used by the courier for the delivery.", "type": "string" } } }, "ms_api__dtos__delivery__DeliveryResponseSerializer": { "title": "DeliveryResponseSerializer", "description": "Scheme used for fetch full delivery object", "type": "object", "properties": { "delivery_id": { "title": "Delivery ID", "description": "A unique identifier for the delivery.", "type": "string" }, "order_id": { "title": "Order ID", "description": "A unique identifier for the order.", "type": "string" }, "store_id": { "title": "Store ID", "description": "A unique identifier for the store where the order is being processed.", "type": "string" }, "scheduled_order": { "title": "Scheduled Order", "description": "Indicates whether the order is scheduled for a future time or is immediate.", "type": "boolean" }, "delivery_order_id": { "title": "Delivery Order ID", "description": "A unique identifier for the delivery order.", "type": "string" }, "cancellation_reason": { "title": "Cancellation Reason", "description": "The reason for cancellation if the delivery is canceled.", "type": "string" }, "pickup_info": { "title": "Pickup Info", "description": "Detailed information about the pickup location and time.", "allOf": [ { "$ref": "#/components/schemas/ms_api__dtos__delivery__PickupInfo" } ] }, "customer_info": { "title": "Customer Info", "description": "Detailed information about the customer placing the order.", "allOf": [ { "$ref": "#/components/schemas/ms_api__dtos__delivery__CustomerInfoSerializer" } ] }, "drop_off_info": { "title": "Drop Off Info", "description": "Detailed information about the drop-off location and time.", "allOf": [ { "$ref": "#/components/schemas/ms_api__dtos__delivery__DropOffInfo" } ] }, "charges": { "title": "Charges", "description": "Detailed breakdown of charges for the delivery service.", "allOf": [ { "$ref": "#/components/schemas/ms_api__dtos__delivery__ChargesSerializer" } ] }, "status": { "title": "Status", "description": "The current status of the delivery order.", "allOf": [ { "$ref": "#/components/schemas/DeliveryStatus" } ] }, "created_at": { "title": "Created At", "description": "The timestamp when the delivery order was created.", "type": "string", "format": "date-time" }, "delivery_service": { "title": "Delivery Service", "description": "The service handling the delivery.", "allOf": [ { "$ref": "#/components/schemas/DeliveryServiceEnum" } ] }, "courier_info": { "title": "Courier Info", "description": "Detailed information about the courier assigned to the delivery.", "allOf": [ { "$ref": "#/components/schemas/CourierInfoSerializer" } ] }, "delivery_at": { "title": "Delivery At", "description": "The timestamp when the delivery was completed.", "type": "string", "format": "date-time" }, "canceled_at": { "title": "Canceled At", "description": "The timestamp when the delivery was canceled.", "type": "string", "format": "date-time" }, "accepted_at": { "title": "Accepted At", "description": "The timestamp when the delivery was accepted.", "type": "string", "format": "date-time" }, "is_mock_delivery": { "title": "Is Mock Delivery", "description": "flag indicating real or fake delivery created", "default": false, "type": "boolean" }, "tracking_url": { "title": "Tracking URL", "description": "The URL for tracking the delivery", "type": "string" }, "items": { "title": "Items", "description": "Detailed information about the items being delivered.", "type": "array", "items": { "$ref": "#/components/schemas/DeliveryItemDTO" } } }, "required": [ "delivery_id", "order_id", "store_id", "pickup_info", "customer_info", "drop_off_info", "charges", "status", "created_at", "delivery_service", "items" ] }, "DeliveriesResponseSerializer": { "title": "DeliveriesResponseSerializer", "type": "object", "properties": { "deliveries": { "title": "Deliveries", "description": "A list of deliveries containing detailed information about each delivery.", "type": "array", "items": { "$ref": "#/components/schemas/ms_api__dtos__delivery__DeliveryResponseSerializer" } } }, "required": [ "deliveries" ] } }, "securitySchemes": { "apiKeyAuth": { "type": "apiKey", "description": "Enter the token with the `Bearer: ` prefix, e.g. 'Bearer abcde12345'.", "name": "Authorization", "in": "header" } } }, "security": [ { "apiKeyAuth": [] } ] } ```