Sign in
Batches

Import data files

Import csv, xls and xlsx data files for: Beta<br/>

  • trackers data
  • orders data
  • shipments data
  • billing data (soon)<br/><br/> This operation will return a batch operation that you can poll to follow the import progression.
post/v1/batches/data/import

Query parameters

data_filestring binary
data_templatestring

A data template slug to use for the import.<br/> When nothing is specified, the system default headers are expected.

resource_type'billing' | 'order' | 'shipment' | 'trackers'

The type of the resource to import

Response

idstring

A unique identifier

status'queued' | 'running' | 'failed' | 'completed' | 'completed_with_errors' required
resource_type'orders' | 'shipments' | 'trackers' | 'billing' required
created_atstring date-time required
updated_atstring date-time required
test_modeboolean required

Changes

No recorded changes to this endpoint across all 1 revision of this API.