Simulation

Simulate shipment status

POSThttps://api.firstleeward.com/v0/simulation/card-shipments/:id/status

Simulates a card shipment status change in sandbox. Drives production and shipping progress for a submitted shipment. Returns 204; observe the change via CARD_SHIPMENT_STATUS_UPDATED.

Authorizations

Authorizationstring · headerrequired

API key as Bearer token, e.g. Bearer YOUR_API_KEY

Headers

Leeward-Versionenum<string>required

API version (YYYY-MM-DD). Available option: 2026-09-18

Path Parameters

idstring<uuid>required

Body

application/json

statusstringrequired

Target shipment status to simulate

Available options:IN_PRODUCTIONREADY_TO_SHIPIN_TRANSITOUT_FOR_DELIVERYDELIVEREDDELIVERY_FAILEDEXCEPTIONCANCELED

Response

204Response for status 204

400The resource is not in a valid state for the requested simulation

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

detailobject | nullrequired