List all batch operations

GET 
/v1/batches/operations

Retrieve all batch operations. Beta

Responses

200

application/json

Schema

Schema

count integernullable
next urinullable
previous urinullable

results

object[]

required

Array [

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)

{
  "count": 0,
  "next": "string",
  "previous": "string",
  "results": [
    {
      "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...