Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Save final orders as order_name instead of order_id

Open
#995 7 comments 1 reaction 1 assignee View on GitHub

@kevinlacaille is already working on this.

Since Jul 31, 2023.

Assessment

This issue has not been assessed yet.

Description

enhancement sdk-2023.7

Current Problem

As a customer, I give each tasking order a unique name which is how I identify these orders in my organisation. For example, 1406_XY_XZ_LST, but when I download these fulfilled orders, the final folder name (or zipped file) is saved as order-id, which is good for Planet's systems, but not for me as a final user. This increases my workload, and the names of these folders are meaningless to my workflow.

My current workaround for this is reading the names of these folders (order-ids) one by one, make a GET request to https://developers.planet.com/apis/orders/reference/#tag/Orders/operation/getOrder, retrieve the order name from the response, and rename the folder. This is a cumbersome four-step process.

Proposed Solution
In this line https://github.com/planetlabs/planet-client-python/blob/74e8b77af6c9c33b7a8dc85f57eacfe226eb6b63/planet/clients/orders.py#L233 we, have an option of filename. This should be the order_name. Additionally, in this line https://github.com/planetlabs/planet-client-python/blob/74e8b77af6c9c33b7a8dc85f57eacfe226eb6b63/planet/clients/orders.py#L264 we do have the option of giving an argument to the function, which is 'order_id' currently. If this changes to 'order_name', it will be better, because 'order_id' argument is read by this line https://github.com/planetlabs/planet-client-python/blob/74e8b77af6c9c33b7a8dc85f57eacfe226eb6b63/planet/clients/orders.py#L257 which saves the folder ultimately.

Describe alternatives you've considered

Additional context
One of my customers complained that they can't use SDK because the final orders are saved in a folder/zipfile as order_ids, and they can't manually read each ID, copy it, search for it in Explorer, by opening each order one by one and comparing. Thus I created a script that could automate for them, but this creates additional load on Planet's servers, thus increasing cost. If we have SDK in-built solution, it will be good for the customer.

Dominant language
Python
Stars
299
Forks
100
Avg merge
7d 8h
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from planetlabs/planet-client-python

All issues in planetlabs/planet-client-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.