# Filters
URL: https://support.starshipit.com/articles/14700000001024-filters
Canonical: https://support.starshipit.com/articles/14700000001024-filters
Markdown: https://support.starshipit.com/articles/14700000001024-filters.md
Updated: 2026-06-18

> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).

> Use Starshipit API filters to narrow order searches and list responses.

Use filters when an endpoint supports a filter query parameter and you need to narrow the records Starshipit returns. Filters are most useful for order searches, list views, and sync jobs that only need a specific subset of orders.

## Filter syntax

Starshipit filters use this pattern:

```text
Column:::Value
```

If you send more than one filter, keep each filter as a separate value if the endpoint supports repeated filter parameters. URL-encode spaces and special characters in query strings.

## Common filters

| Filter | Use when | Example |
| --- | --- | --- |
| `Order` | You know the source order number. | `Order:::1419` |
| `Name` | You need orders for a recipient name. | `Name:::John Smith` |
| `Address` | You need to check address validation state. | `Address:::valid` |
| `Country` | You need orders going to a specific country. | `Country:::Australia` |
| `SKU` | You need orders containing a product SKU. | `SKU:::MOBILE-CASE-BLK` |

## Request example

The exact parameter name depends on the endpoint. For endpoints that accept a `filter` parameter, a request can look like this:

```bash
curl --request GET \
  --url 'https://api.starshipit.com/api/orders/search?filter=Order%3A%3A%3A1419' \
  --header "StarShipIT-Api-Key: YOUR_API_KEY" \
  --header "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY"
```

## Build reliable filtered syncs

Use filters with pagination so your integration requests a predictable set of records. Store the query values you used for each sync run so support teams can reproduce the same request later.

If an endpoint also supports date, status, page, or page size parameters, use those fields with filters instead of making broad requests and filtering everything in your own system.

## Related guides

- [Starshipit API fundamentals](/articles/developer-center/starshipit-api/api-fundamentals)
- [Import orders, print in Starshipit, and update the source system](/articles/developer-center/starshipit-api/import-orders-into-starshipit)
- [Starshipit API reference](/developers/api-reference/starshipit)