Sign in

v4

OpenAPI 3.1.02026-08-012402353.8 MB

Sandbox: Advance the shipment status of a Physical Card

This endpoint allows you to simulate advancing the shipment status of a Physical Card, to simulate e.g., that a physical card was attempted shipped but then failed delivery.

post/simulations/physical_cards/{physical_card_id}/advance_shipment

Path parameters

physical_card_idstring required

The Physical Card you would like to action.

Request body

shipment_status'pending' | 'canceled' | 'submitted' | 'acknowledged' | 'rejected' | 'shipped' | 'returned' | 'requires_attention' required

The shipment status to move the Physical Card to.

Example request

{
  "shipment_status": "shipped"
}

Response

Physical Card

card_idstring required

The identifier for the Card this Physical Card represents.

created_atstring date-time required

The ISO 8601 date and time at which the Physical Card was created.

idstring required

The physical card identifier.

idempotency_keystring nullable required

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.

physical_card_profile_idstring nullable required

The Physical Card Profile used for this Physical Card.

status'active' | 'disabled' | 'canceled' required

The status of the Physical Card.

type'physical_card' required

A constant representing the object's type. For this resource it will always be physical_card.

Example response

{
  "card_id": "card_oubs0hwk5rn6knuecxg2",
  "cardholder": {
    "first_name": "Ian",
    "last_name": "Crease"
  },
  "created_at": "2020-01-31T23:59:59Z",
  "id": "physical_card_ode8duyq5v2ynhjoharl",
  "idempotency_key": null,
  "physical_card_profile_id": "physical_card_profile_m534d5rn9qyy9ufqxoec",
  "shipment": {
    "address": {
      "city": "New York",
      "country": "US",
      "line1": "33 Liberty Street",
      "line2": "Unit 2",
      "line3": null,
      "name": "Ian Crease",
      "postal_code": "10045",
      "state": "NY"
    },
    "method": "usps",
    "schedule": "next_day",
    "status": "shipped",
    "tracking": {
      "number": "9400110200881234567890",
      "return_number": null,
      "return_reason": null,
      "shipped_at": "2020-01-31T23:59:59Z",
      "updates": [
        {
          "carrier_estimated_delivery_at": null,
          "category": "delivered",
          "city": null,
          "created_at": "2020-01-31T23:59:59Z",
          "postal_code": "10001",
          "state": null
        }
      ]
    }
  },
  "status": "active",
  "type": "physical_card"
}