DeliveryAddressesApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| createDeliveryAddresses | POST /delivery-addresses | Create a new delivery address |
| deleteDeliveryAddresses | DELETE /delivery-addresses/{id} | Delete a delivery address |
| getDeliveryAddresses | GET /delivery-addresses/{id} | Get details of a specific delivery address |
| listDeliveryAddresseses | GET /delivery-addresses | List delivery addresses for the authenticated user |
| updateDeliveryAddresses | PUT /delivery-addresses/{id} | Update an existing delivery address |
createDeliveryAddresses
DeliveryAddressResponse createDeliveryAddresses(DeliveryAddressInput)
Create a new delivery address
Creates a new delivery address for the authenticated user with validation for name, address text, and coordinates. If marked as default, automatically unsets all other addresses as non-default. Prevents duplicate addresses for the same user.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| DeliveryAddressInput | DeliveryAddressInput | Delivery address details including name, address, coordinates, and default status |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
deleteDeliveryAddresses
MessageResponse deleteDeliveryAddresses(id)
Delete a delivery address
Permanently removes a delivery address from the authenticated user’s account. The address must belong to the user to be deleted. This operation cannot be undone and returns a success message upon completion.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Unique identifier of the delivery address to delete | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getDeliveryAddresses
DeliveryAddressResponse getDeliveryAddresses(id)
Get details of a specific delivery address
Retrieves complete information for a single delivery address by its ID. The address must belong to the authenticated user, otherwise a not found error will be returned for security purposes.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Unique identifier of the delivery address to retrieve | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listDeliveryAddresseses
PaginatedResponse_DeliveryAddressResponse listDeliveryAddresseses(vendor_id, action, page, per_page)
List delivery addresses for the authenticated user
Retrieves all delivery addresses belonging to the authenticated user with optional filtering by default status or vendor delivery availability. When vendor IDs are provided, each address includes a can_deliver flag indicating service availability.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Optional vendor ID to check delivery availability (uses PostGIS for efficient geo-check) | [optional] [default to null] |
| action | String | Optional filter action: “default” returns only default address, otherwise returns all addresses ordered by latest | [optional] [default to null] |
| page | Integer | [optional] [default to null] | |
| per_page | Integer | [optional] [default to null] |
Return type
PaginatedResponse_DeliveryAddressResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updateDeliveryAddresses
DeliveryAddressResponse updateDeliveryAddresses(id, DeliveryAddressInput)
Update an existing delivery address
Updates an existing delivery address for the authenticated user. Validates all input fields and ensures the address belongs to the user. If the is_default flag is set, automatically unsets all other addresses as non-default.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Unique identifier of the delivery address to update | [default to null] |
| DeliveryAddressInput | DeliveryAddressInput | Updated delivery address details including name, address, coordinates, and default status |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8