Create tracker batch

POST 
/v1/batches/trackers

Create tracker batch. Beta

Request

application/json

Body

required

trackers

object[]

required

The list of tracking info to process.

Array [

tracking_number stringrequired

The package tracking number

carrier_name stringrequired

Possible values: [allied_express, allied_express_local, amazon_shipping, aramex, asendia_us, australiapost, boxknight, bpost, canadapost, canpar, chronopost, colissimo, dhl_express, dhl_parcel_de, dhl_poland, dhl_universal, dicom, dpd, dpdhl, fedex, fedex_ws, generic, geodis, hay_post, laposte, locate2u, nationex, purolator, roadie, royalmail, seko, sendle, tge, tnt, ups, usps, usps_international, usps_wt, usps_wt_international, zoom2u]

The tracking carrier

account_number stringnullable

The shipper account number

reference stringnullable

The shipment reference

info

object

nullable

carrier_tracking_link stringnullable

The carrier tracking link

customer_name stringnullable

The customer name

expected_delivery stringnullable

The expected delivery date

note stringnullable

A tracking note

order_date stringnullable

The package order date

order_id stringnullable

The package order id or number

package_weight stringnullable

The package weight

package_weight_unit stringnullable

The package weight unit

shipment_package_count stringnullable

The package count

shipment_pickup_date stringnullable

The shipment pickup date

shipment_delivery_date stringnullable

The shipment delivery date

shipment_service stringnullable

The shipment service

shipment_origin_country stringnullable

The shipment origin country

shipment_origin_postal_code stringnullable

The shipment origin postal code

shipment_destination_country stringnullable

The shipment destination country

shipment_destination_postal_code stringnullable

The shipment destination postal code

shipping_date stringnullable

The shipping date

signed_by stringnullable

The person who signed for the package

source stringnullable

The tracker source

metadata

object

The carrier user metadata.

property name* any

Default value: [object Object]

The carrier user metadata.

]

Responses

200

application/json

Schema

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

Example (from schema)

{
  "id": "string",
  "status": "queued",
  "resource_type": "orders",
  "resources": [
    {
      "id": "string",
      "status": "queued",
      "errors": {}
    }
  ],
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "test_mode": true
}

404

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

500

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

Loading...