Accessing Orders by Name in the Orders API

Rafael Ricardo Bastidas Mendez

December 19, 2024 03:09

The Orders API provides functionality to search or list orders based on their name.

Steps to Search or List Orders by Name

The following query parameters can be used to filter orders by name:

Exact Match: Use the name parameter to search for an order by its exact name. Replace <order_name> with the specific name of the order.

Example:
```
GET: https://api.planet.com/compute/ops/orders/v2?name=<order_name>
```
Partial Match: Use the name__contains parameter to search for orders that contain a specific substring in their name. Replace <substring> with the desired text.

Example:
```
GET: https://api.planet.com/compute/ops/orders/v2?name__contains=<substring>
```

Parameter	Data Type	Description
`name`	string	Filter orders by exact name.
`name__contains`	string	Filter orders by names containing a string.

Ensure you have proper authorization and access rights when making API requests.
Always verify your query parameters to ensure you receive the desired data.

For more information on available query parameters, refer to the Orders API documentation.