Search returns
GET {{baseUrl}}/api/v1/Returns?filters.partnerPO=<>&filters.sourceKey=<>&filters.status=<>&filters.from=<>&filters.to=<>&filters.page=<>&filters.pageSize=<>&filters.receiverCompanyId=<>&filters.senderCompanyId=<>&filters.linkkey=<>&filters.advanced=<>
Request rate limited to 10 requests per second with bursts up to 100 requests.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filters.partnerPO | string | The partner's purchase order number. | |
filters.sourceKey | string | Source key is usually the unique key the sender uses to find this document. Sometime this might be the same as the PartnerPO. | |
filters.status | string | The status of the document. Use Status endpoint to view valid Statuses. | |
filters.from | string | Beginning of time search window. | |
filters.to | string | End of time search window. | |
filters.page | string | Page number | |
filters.pageSize | string | Page size | |
filters.receiverCompanyId | string | This Id is indicate who is received this document. Use the Partner endpoint to discovery valid company Ids. | |
filters.senderCompanyId | string | This Id is indicate who is sent this document. Use the Partner endpoint to discovery valid company Ids. | |
filters.linkkey | string | The linkkey identifies a group of related documents. It ties the Order to all the Shipments and Invoices. | |
filters.advanced | string | Advanced query options. |