Search claims
search_claimsSearch delivery claims by filters such as status, phone, or dates. Use offset/limit or cursor pagination to navigate results sorted by creation date.
Instructions
Search claims by filters with pagination (sorted by creation date). Returns claims (each shaped like get_claim) and a cursor for the next page. Pagination: either offset/limit, or cursor-based — pass the cursor from the previous response (other filters are then not needed).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many claims to return (up to 1000). | |
| phone | No | Filter by a phone number from the claim contacts. | |
| state | No | Status group: active, finished or delayed claims. | |
| cursor | No | Cursor from the previous response — an alternative to offset/limit. | |
| due_to | No | Courier arrival no later than (ISO-8601). | |
| offset | No | Offset for offset/limit pagination (default 0). | |
| status | No | Filter by status. Known statuses: new, estimating, estimating_failed, ready_for_approval, accepted, performer_lookup, performer_draft, performer_found, performer_not_found, pickup_arrived, ready_for_pickup_confirmation, pickuped, delivery_arrived, ready_for_delivery_confirmation, delivered, delivered_finish, pay_waiting, returning, return_arrived, ready_for_return_confirmation, returned, returned_finish, failed, cancelled, cancelled_with_payment, cancelled_by_taxi, cancelled_with_items_on_hands. | |
| claim_id | No | Filter by claim id. | |
| due_from | No | Courier arrival no earlier than (ISO-8601). | |
| created_to | No | Created no later than (ISO-8601). | |
| created_from | No | Created no earlier than (ISO-8601). | |
| external_order_id | No | Filter by the external order id. |