KAkarrio
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

Request

  • Base URL
    https://karrio.io (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP basic
    • or API key in header Authorization
    • or OAuth 2
      Authorization code/oauth/authorize/
      Token URL/oauth/token/
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

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

Request body multipart/form-data

resource_typestring
data_templatestring
data_filestring binary

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 operation across all 1 revision of this API.