increase-test
POST/simulations/physical_cards/{physical_card_id}/tracking_updates

Create a physical card shipment tracking update in the sandbox

Simulates receiving a tracking update for a physical card shipment. Set category to the tracking event and optionally include its location or the carrier's estimated delivery time. Returns the physical card with the updated shipment tracking details.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 5 body fields
physical_card_idstringrequired
The identifier of the physical card whose shipment tracking you want to update.

Tracking event details for the physical card shipment. category is required; the location and estimated delivery fields are optional.

carrier_estimated_delivery_atstringoptional
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the carrier expects the card to be delivered.
categorystringrequired
The type of tracking event.
Allowed:in_transitprocessed_for_deliverydelivereddelivery_issuereturning_to_senderreturned_to_sender
citystringoptional
The city where the event took place.
postal_codestringoptional
The postal code where the event took place.
statestringoptional
The state where the event took place.

3 status codes
200Returns the physical card with its updated shipment tracking details.
account_idstringrequired
The identifier for the Account this Physical Card belongs to.
card_idstringrequired
The identifier for the Card this Physical Card represents.
cardholderobjectrequired
Details about the cardholder, as it appears on the printed card.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Physical Card was created.
idstringrequired
The physical card identifier.
idempotency_keystringrequired
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
physical_card_profile_idstringrequired
The Physical Card Profile used for this Physical Card.
shipmentobjectrequired
The details used to ship this physical card.
statusstringrequired
The status of the Physical Card.
Allowed:activedisabledcanceled
typestringrequired
A constant representing the object's type. For this resource it will always be `physical_card`.
Allowed:physical_card
4XXReturned when the request cannot be processed because of a client-side error.
5XXReturned when a server-side error prevents the request from being processed.

Error handling

The physical_card_id path parameter must identify the physical card to update. category is required and must be one of: in_transit, processed_for_delivery, delivered, delivery_issue, returning_to_sender, or returned_to_sender; carrier_estimated_delivery_at must use ISO 8601 date-time format when provided. city, postal_code, and state must each contain 1 to 200 characters when provided.