Saltar al contenido
duxt
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).

A consignment changed

post
consignmentChanged
Webhook

Sent to the address registered for your account whenever a consignment you can see changes. Answer with any 2xx.

Autorización

  • Cualquiera de estos

    • apiKeyapiKey · X-Api-Key · Cabecera

      A key from the account page.

  • Cualquiera de estos

    • bearerhttp · bearer

      A token obtained from the authorisation server.

Cuerpo de la solicitud

application/json

objectConsignmentOne consignment, as the API sees it.
  • idstringSolo lectura
  • reference*Obligatoriostringlongitud mín 1longitud máx 120
  • status*ObligatoriostringConsignmentStatusbooked | loading | sailing | landed | cancelledWhere a consignment has got to.
  • createdAtstringSolo lectura
  • parentanyConsignmentSe refiere a sí mismo; desplegado arriba.
  • tagsarray<string>únicos

    Cada elemento

    string
  • metadataobject

    Cualquier otra propiedad

    string
json
{
  "reference": "string",
  "status": "booked",
  "parent": null,
  "tags": [
    "string"
  ],
  "metadata": {}
}

Respuestas

200
Acknowledged.

Sin cuerpo.

Enviar una solicitud

Autenticación

Lo que escriba aquí permanece en esta pestaña, no se guarda y solo se envía al servidor que eligió.

Este cuerpo no puede mostrarse como formulario: edítalo como JSON.

La solicitud la envía su navegador, directamente a ese servidor.

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