Skip to main content
Skip to main content

StoreGetOrdersParams

Filters to narrow down the looked-up order, with configurations applied on the retrieved order.

Properties

display_idnumberRequired
Display ID of the order.
emailstringRequired
Email of the order.
shipping_addressShippingAddressPayload
Filter the retrieved order by its shipping address details.
expandstring
Comma-separated relations that should be expanded in the returned data.
fieldsstring
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
Was this section helpful?