GetOrderEditsParams

Parameters used to filter and configure the pagination of the retrieved order edits.

constructor

Parameters

argsunknown[]Required

---

Properties

qstring

Search term to search order edits by their internal note.

order_idstring

Filter the order edits by their associated order's ID.

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.

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

limitnumber

Limit the number of items returned in the list.

Default: 20

orderstring

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.