DeliveryUpdate

A simulated transfer delivery update (Sandbox).

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

created, err := client.DeliveryUpdate(nil).Create(map[string]any{"transfer_id": 1, "delivery_update": "example", "delivery_update_path": []any{}}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)

Lua

Construct client as shown in the Lua setup, then call the operations:

local created, err = client:DeliveryUpdate():create({ transfer_id = 1, delivery_update = "example", delivery_update_path = {} })

PHP

Construct client as shown in the PHP setup, then call the operations:

$created = $client->DeliveryUpdate()->create(["transfer_id" => 1, "delivery_update" => "example", "delivery_update_path" => []]);

Python

Construct client as shown in the Python setup, then call the operations:

created = client.DeliveryUpdate().create({ "transfer_id": 1, "delivery_update": "example", "delivery_update_path": [] })

Ruby

Construct client as shown in the Ruby setup, then call the operations:

created = client.DeliveryUpdate.create({ "transfer_id" => 1, "delivery_update" => "example", "delivery_update_path" => [] })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const created = await client.DeliveryUpdate().create({ transfer_id: 1, delivery_update: "example", delivery_update_path: [] })

Fields

create

POST /simulation/transfers/{transferId}/delivery-update

Operation ID: simulationTransferDeliveryUpdate.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Responses

200: Observation accepted for asynchronous webhook processing

application/json

Example response:

{
  "observation_id": "550e8400-e29b-41d4-a716-446655440000",
  "occurred_at": "2026-10-01T10:00:00.123Z"
}

400: Invalid request. Malformed input and domain validation return a single error; field validation can return an errors array

application/json

The response is object or object.

401: Authentication is missing or invalid

403: Access denied by the authentication or authorization policy

404: Transfer does not exist or is not accessible to the caller

application/json

Example response:

{
  "errors": [
    {
      "arguments": [],
      "code": "transfer_not_found",
      "message": "Transfer not found"
    }
  ]
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

500: Internal error while processing the simulation

application/json

The response is object or object.

503: Simulation temporarily unavailable because a required dependency or transfer routing is unavailable

application/json

Example response:

{
  "errors": [
    {
      "arguments": [],
      "code": "service_unavailable",
      "message": "The simulation is temporarily unavailable. Please try again."
    }
  ]
}