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.

Autorisierung

Dieser Endpunkt benötigt keine Authentifizierung.

Anfragekörper Erforderlich

application/json

object

instructions*Erforderlicharray<any>min. Elemente 1max. Elemente 50
Jedes Element
anyInstruction
Genau eines von
objectRelabelInstruction
op*Erforderlichany
consignmentId*Erforderlichstring
reference*Erforderlichstring
objectRetagInstruction
op*Erforderlichany
consignmentId*Erforderlichstring
tags*Erforderlicharray<string>
Jedes Element
string
Unterschieden anhand von op

json

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

Antworten

200

What each instruction did.

application/json

array<any>

Jedes Element

any

Genau eines von

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

json

[
  {
    "done": true
  }
]

Anfrage senden

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

Diese Seite bearbeiten