Export to CSV/XLSX
GET {{baseUrl}}/api/v1/Shipments/Export?fields=<get>&fileType=<>&LogicbrokerKeys=<>&delimiter=<>&filter.partnerPO=<>&filter.sourceKey=<>&filter.status=<>&filter.from=<>&filter.to=<>&filter.page=<>&filter.pageSize=<>&filter.receiverCompanyId=<>&filter.senderCompanyId=<>&filter.linkkey=<>&filter.advanced=<>
The 'fields' parameter accepts a comma delimited list of JSON paths, for example: 'Identifier.logicbrokerKey, BillToAddress.FirstName'. It is also possible to rename these fields using syntax like 'DocumentDate as Date' or 'DocumentDate Date'. You must specify a value for either the 'LogicbrokerKeys' parameter or the 'filter' parameter.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields | string | The fields to export. | |
fileType | string | Valid options are csv, xlsx, xml, json and legacy. | |
LogicbrokerKeys | string | The logicbroker keys. | |
delimiter | string | The column delimiter to use for CSV export. | |
filter.partnerPO | string | The partner's purchase order number. | |
filter.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. | |
filter.status | string | The status of the document. Use Status endpoint to view valid Statuses. | |
filter.from | string | Beginning of time search window. | |
filter.to | string | End of time search window. | |
filter.page | string | Page number | |
filter.pageSize | string | Page size | |
filter.receiverCompanyId | string | This Id is indicate who is received this document. Use the Partner endpoint to discovery valid company Ids. | |
filter.senderCompanyId | string | This Id is indicate who is sent this document. Use the Partner endpoint to discovery valid company Ids. | |
filter.linkkey | string | The linkkey identifies a group of related documents. It ties the Order to all the Shipments and Invoices. | |
filter.advanced | string | Advanced query options. |