Run a batch

post

/batches

runBatch

Takes a list of instructions and applies them in order. This endpoint needs no authentication, which is why it takes nothing destructive.

Autorização

Este ponto final não precisa de autenticação.

Corpo do pedido Obrigatório

application/json

object

instructions*Obrigatórioarray<any>elementos mín 1elementos máx 50
Cada elemento
anyInstruction
Exatamente um de
objectRelabelInstruction
op*Obrigatórioany
consignmentId*Obrigatóriostring
reference*Obrigatóriostring
objectRetagInstruction
op*Obrigatórioany
consignmentId*Obrigatóriostring
tags*Obrigatórioarray<string>
Cada elemento
string
Distinguido por op

json

{
  "instructions": [
    {
      "op": "relabel",
      "consignmentId": "00000000-0000-4000-8000-000000000000",
      "reference": "string"
    }
  ]
}

Respostas

200

What each instruction did.

application/json

array<any>

Cada elemento

any

Exatamente um de

object
- doneboolean
objectProblem
- title*ObrigatóriostringA short, human-readable summary.
- status*Obrigatóriointegermín 400máx 599
- detailstring | null

json

[
  {
    "done": true
  }
]

Enviar um pedido

curl 'https://api.example.org/v3/consignments' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer demo-token' \
  -H 'X-Request-Id: 00000000-0000-4000-8000-000000000000' \
  -d '{
  "reference": "HB-1042",
  "status": "booked"
}'

Editar esta página