Skip to main content

Import data files

POST 
/v1/batches/data/import

Import csv, xls and xlsx data files for: Beta

  • trackers data
  • orders data
  • shipments data
  • billing data (soon)

    This operation will return a batch operation that you can poll to follow the import progression.

Request​

Query Parameters

    data_file binary
    data_template string

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

    resource_type string

    Possible values: [billing, order, shipment, trackers]

    The type of the resource to import

Body

    resource_type string
    data_template string
    data_file binary

Responses​

Schema

    id string

    A unique identifier

    status stringrequired

    Possible values: [queued, running, failed, completed, completed_with_errors]

    resource_type stringrequired

    Possible values: [orders, shipments, trackers, billing]

    resources

    object[]

    required

  • Array [

    • id string

    A unique identifier

    status stringrequired

    Possible values: [queued, running, failed, completed, completed_with_errors]

    The batch operation resource status

    errors

    object

    nullable

    Resource processing errors

    property name* anynullable

    Resource processing errors

  • ]

    • created_at date-timerequired
    updated_at date-timerequired
    test_mode booleanrequired
Loading...