Versión futura

Está consultando la documentación de una versión futura. Su documentación y sus funcionalidades pueden cambiar.

Esta página aún no está disponible en tu idioma

La estás leyendo en English (UK).

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.

Autorización

Este punto final no necesita autenticación.

Cuerpo de la solicitud Obligatorio

application/json

object

instructions*Obligatorioarray<any>elementos mín 1elementos máx 50
Cada elemento
anyInstruction
Exactamente uno de
objectRelabelInstruction
op*Obligatorioany
consignmentId*Obligatoriostring
reference*Obligatoriostring
objectRetagInstruction
op*Obligatorioany
consignmentId*Obligatoriostring
tags*Obligatorioarray<string>
Cada elemento
string
Se distingue por op

json

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

Respuestas

200

What each instruction did.

application/json

array<any>

Cada elemento

any

Exactamente uno de

object
- doneboolean
objectProblem
- title*ObligatoriostringA short, human-readable summary.
- status*Obligatoriointegermín 400máx 599
- detailstring | null

json

[
  {
    "done": true
  }
]

Enviar una solicitud

curl 'https://api.example.org/v3/consignments?limit=20&cursor=string&status=%5B%0A++%22booked%22%0A%5D&session=string' \
  -H 'Authorization: Bearer demo-token' \
  -H 'X-Request-Id: 00000000-0000-4000-8000-000000000000'

Editar esta página