GET
/v1/climate/ordersList Climate orders
Lists Climate orders sorted by creation date, with the most recently created orders first. Use cursor parameters and limit to paginate the results, and use expand to request expanded response fields. Each order represents an intent to purchase a Climate product funded from the merchant balance.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
ending_beforestringoptional
Cursor identifying the order before which to return results.
expandarray<string>optional
Fields to expand in the response. Each field name can be up to 5,000 characters.
limitintegeroptional
Maximum number of Climate orders to return. Must be between 1 and 100. Defaults to 10 when omitted.
starting_afterstringoptional
Cursor identifying the order after which to return results.
200Returns a paginated list of Climate orders containing order amounts, currency, product, delivery details, expected delivery year, status, identifiers, and creation times.
dataarray<ClimateOrder>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultReturned when the order list request cannot be processed because a supplied cursor, pagination value, or expansion value is invalid.
errorobjectrequired
Error handling
limit must be an integer between 1 and 100 and defaults to 10 when omitted. starting_after and ending_before must identify valid list positions when supplied. Each expand value can name a response field to expand and must not exceed 5,000 characters.