v1
latestOpenAPI 3.0.12026-07-243124341009.5 KBPartnerExport
Get Partner Export Batch Paged Data
After getting a batch ready event, call this endpoint to retrieve a paginated set of batch items for the event's bulk export batch ID. To get all data for a batch, start with page 1 (page size up to 100) and iterate until last page of data is received.
get/v1/partner-export/{exportBatchId}/{page}/{pageSize}
Path parameters
exportBatchIdstring required
The unique identifier for the export batch.
pagestring required
The page number to retrieve in the paginated response.
pageSizestring required
The number of items to include per page in the paginated response.
Headers
Tenantstring
Tenant company code for scoped data access during the request.
FrontOfficeTenantIdinteger
An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.
RequestIdstring uuid required
The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.
Response
200 response