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

Advance a physical card shipment status in the sandbox

Simulates advancing the shipment status of a physical card. Set shipment_status to the status you want to simulate, such as shipped or returned. Returns the updated physical card with its shipment details.

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

1 parameter · 1 body field
physical_card_idstringrequired
The identifier of the physical card whose shipment status you want to advance.

The shipment status to simulate for the physical card.

shipment_statusstringrequired
The shipment status to move the Physical Card to.
Allowed:pendingcanceledsubmittedacknowledgedrejectedshippedreturnedrequires_attention

3 status codes
200Returns the updated physical card, including its current status and shipment 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 action. shipment_status is required and must be one of: pending, canceled, submitted, acknowledged, rejected, shipped, returned, or requires_attention.