returns_getlist
Retrieve filtered lists of returns from ServiceTitan by specifying criteria like date ranges, IDs, business units, or custom fields for streamlined return management.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| active | No | What kind of items should be returned (only active items will be returned by default) Values: [True, Any, False] | |
| batchId | No | Format - int64. Batch filter | |
| businessUnitIds | No | Filter by a collection of business units | |
| createdBefore | No | Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC) | |
| createdOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC) | |
| customFields.Fields | No | Collection of custom field pairs (name, value) to filter by | |
| customFields.Operator | No | Can be "Or" or "And" Values: [And, Or] | |
| externalDataApplicationGuid | No | Format - guid. If this guid is provided, external data corresponding to this application guid will be returned. | |
| externalDataKey | No | Performs lookup by external data key, 'externalDataValues' must also be provided. | |
| externalDataValues | No | Performs lookup by external data values (maximum 50), 'externalDataKey' must also be provided. | |
| ids | No | Perform lookup by multiple IDs (maximum 50) | |
| includeTotal | No | Whether total count should be returned | |
| inventoryLocationIds | No | Filter by a collection of inventory locations | |
| jobId | No | Format - int64. Job filter | |
| modifiedBefore | No | Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC) | |
| modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC) | |
| number | No | Number filter | |
| page | No | Format - int32. The logical number of page to return, starting from 1 | |
| pageSize | No | Format - int32. How many records to return (50 by default) | |
| purchaseOrderId | No | Format - int64. Purchase order filter | |
| referenceNumber | No | Reference number filter | |
| returnDateBefore | No | Format - date-time (as date-time in RFC3339). Filters by returns with return date before certain date/time | |
| returnDateOnOrAfter | No | Format - date-time (as date-time in RFC3339). Filters by returns with return date on or after certain date/time | |
| sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, ModifiedOn, CreatedOn. | |
| syncStatuses | No | Filter by a collection of sync statuses | |
| tenant | Yes | Format - int64. Tenant ID | |
| vendorIds | No | Filter by a collection of vendors |