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.

Autorisation

Ce point de terminaison ne demande aucune authentification.

Corps de la requête Obligatoire

application/json

object

instructions*Obligatoirearray<any>éléments min 1éléments max 50
Chaque élément
anyInstruction
Exactement l’un de
objectRelabelInstruction
op*Obligatoireany
consignmentId*Obligatoirestring
reference*Obligatoirestring
objectRetagInstruction
op*Obligatoireany
consignmentId*Obligatoirestring
tags*Obligatoirearray<string>
Chaque élément
string
Distingué par op

json

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

Réponses

200

What each instruction did.

application/json

array<any>

Chaque élément

any

Exactement l’un de

object
- doneboolean
objectProblem
- title*ObligatoirestringA short, human-readable summary.
- status*Obligatoireintegermin 400max 599
- detailstring | null

json

[
  {
    "done": true
  }
]

Envoyer une requête

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"
}'

Modifier cette page