VendorOrdersApi

All URIs are relative to https://business.apis.kesk.app/v1

Method	HTTP request	Description
getVendorOrder	GET /vendors/`{vendor_id}`/orders/`{order_id}`	Retrieve detailed information for a specific vendor order
getVendorOrders	GET /vendors/`{vendor_id}`/orders	List all orders for a vendor with optional filtering

getVendorOrder

VendorOrderResponse getVendorOrder(vendor_id, order_id)

Retrieve detailed information for a specific vendor order

Fetches complete order details for the specified order ID after verifying vendor ownership. Returns an error if the order does not belong to the vendor or if access is denied.

Parameters

Name	Type	Description	Notes
vendor_id	Long	Unique identifier of the vendor who owns the order	[default to null]
order_id	Long	Unique identifier of the order to retrieve	[default to null]

Return type

VendorOrderResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getVendorOrders

PaginatedResponse_VendorOrderResponse getVendorOrders(vendor_id, status, location_id, page, per_page)

List all orders for a vendor with optional filtering

Retrieves a paginated list of orders for the specified vendor with optional status filtering. Verifies that the authenticated user has access to manage the vendor before returning results.

Parameters

Name	Type	Description	Notes
vendor_id	Long	Unique identifier of the vendor whose orders to retrieve	[default to null]
status	String	Optional order status filter (pending, preparing, ready, enroute, delivered, failed, cancelled)	[optional] [default to null]
location_id	Long	Optional location filter	[optional] [default to null]
page	Integer	Page number for pagination (defaults to 1)	[optional] [default to null]
per_page	Integer	Number of items per page (defaults to 10)	[optional] [default to null]

Return type

PaginatedResponse_VendorOrderResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8