---
title: "Advance simulated shipment"
method: POST
path: "/api/v1/test-helpers/checkout-intents/{checkoutIntentId}/shipments/advance"
tags: ["Test Helpers"]
---

# Advance simulated shipment

`POST /api/v1/test-helpers/checkout-intents/{checkoutIntentId}/shipments/advance`

## Request

- Base URL: `https://staging.api.rye.com`
- URL: `https://staging.api.rye.com/api/v1/test-helpers/checkout-intents/{checkoutIntentId}/shipments/advance`
- Auth: API key in header `Authorization`

Advance the simulated shipment for a checkout intent. To trigger delayed or
canceled shipping scenarios, create the checkout intent with a matching
shipping and delivery test product:
https://rye.com/docs/api-v2/testing/test-products#shipping-&-delivery

## Path parameters

- `checkoutIntentId` string, required

## Response `200`

The advanced simulated shipment state

- AdvanceShipmentResponse
  - `shipment` union, required
    - union: Shipments that have tracking information (shipped, delayed, or delivered states)
      - ShippedShipment
        - `updatedAt` string, date-time, required
        - `createdAt` string, date-time, required
        - `marketplaceOrderId` string, required
        - `checkoutIntentId` string, required
        - `id` string, required
        - `trackingEvents` TrackingEvent[], required
          - `status` 'out_for_delivery' | 'delivered' | 'shipped' | 'canceled' | 'delayed' | 'ordered', required
          - `location` EventLocation, required
            - `country` string, nullable
            - `province` string, nullable
            - `city` string, nullable
          - `timestamp` TrackingEventTimestamp, required
            - `local` string, required: ISO 8601 string with timezone offset, e.g. "2025-02-05T17:02:00.000-05:00"
            - `utc` string, date-time, required: UTC timestamp
          - `description` string, nullable, required
        - `shippedAt` string, date-time, required
        - `tracking` ShipmentTracking, required
          - `carrierName` string, nullable
          - `number` string, nullable, required
          - `deliveryDate` DeliveryDate
            - `estimated` string, date-time, required
          - `url` string, nullable
        - `externalId` string, required: The external ID is provided by the marketplace and matches the shipment to their system.
        - `status` 'shipped', required
      - DeliveredShipment
        - `updatedAt` string, date-time, required
        - `createdAt` string, date-time, required
        - `marketplaceOrderId` string, required
        - `checkoutIntentId` string, required
        - `id` string, required
        - `trackingEvents` TrackingEvent[], required
          - `status` 'out_for_delivery' | 'delivered' | 'shipped' | 'canceled' | 'delayed' | 'ordered', required
          - `location` EventLocation, required
            - `country` string, nullable
            - `province` string, nullable
            - `city` string, nullable
          - `timestamp` TrackingEventTimestamp, required
            - `local` string, required: ISO 8601 string with timezone offset, e.g. "2025-02-05T17:02:00.000-05:00"
            - `utc` string, date-time, required: UTC timestamp
          - `description` string, nullable, required
        - `shippedAt` string, date-time, required
        - `tracking` ShipmentTracking, required
          - `carrierName` string, nullable
          - `number` string, nullable, required
          - `deliveryDate` DeliveryDate
            - `estimated` string, date-time, required
          - `url` string, nullable
        - `externalId` string, required: The external ID is provided by the marketplace and matches the shipment to their system.
        - `status` 'delivered', required
        - `deliveredAt` string, date-time, required
      - DelayedShipment
        - `updatedAt` string, date-time, required
        - `createdAt` string, date-time, required
        - `marketplaceOrderId` string, required
        - `checkoutIntentId` string, required
        - `id` string, required
        - `trackingEvents` TrackingEvent[], required
          - `status` 'out_for_delivery' | 'delivered' | 'shipped' | 'canceled' | 'delayed' | 'ordered', required
          - `location` EventLocation, required
            - `country` string, nullable
            - `province` string, nullable
            - `city` string, nullable
          - `timestamp` TrackingEventTimestamp, required
            - `local` string, required: ISO 8601 string with timezone offset, e.g. "2025-02-05T17:02:00.000-05:00"
            - `utc` string, date-time, required: UTC timestamp
          - `description` string, nullable, required
        - `shippedAt` string, date-time, required
        - `tracking` ShipmentTracking, required
          - `carrierName` string, nullable
          - `number` string, nullable, required
          - `deliveryDate` DeliveryDate
            - `estimated` string, date-time, required
          - `url` string, nullable
        - `externalId` string, required: The external ID is provided by the marketplace and matches the shipment to their system.
        - `status` 'delayed', required
      - OutForDeliveryShipment
        - `updatedAt` string, date-time, required
        - `createdAt` string, date-time, required
        - `marketplaceOrderId` string, required
        - `checkoutIntentId` string, required
        - `id` string, required
        - `trackingEvents` TrackingEvent[], required
          - `status` 'out_for_delivery' | 'delivered' | 'shipped' | 'canceled' | 'delayed' | 'ordered', required
          - `location` EventLocation, required
            - `country` string, nullable
            - `province` string, nullable
            - `city` string, nullable
          - `timestamp` TrackingEventTimestamp, required
            - `local` string, required: ISO 8601 string with timezone offset, e.g. "2025-02-05T17:02:00.000-05:00"
            - `utc` string, date-time, required: UTC timestamp
          - `description` string, nullable, required
        - `shippedAt` string, date-time, required
        - `tracking` ShipmentTracking, required
          - `carrierName` string, nullable
          - `number` string, nullable, required
          - `deliveryDate` DeliveryDate
            - `estimated` string, date-time, required
          - `url` string, nullable
        - `externalId` string, required: The external ID is provided by the marketplace and matches the shipment to their system.
        - `status` 'out_for_delivery', required
    - union: Shipments without tracking information
      - OrderedShipment
        - `updatedAt` string, date-time, required
        - `createdAt` string, date-time, required
        - `marketplaceOrderId` string, required
        - `checkoutIntentId` string, required
        - `id` string, required
        - `status` 'ordered', required
      - CanceledShipment
        - `updatedAt` string, date-time, required
        - `createdAt` string, date-time, required
        - `marketplaceOrderId` string, required
        - `checkoutIntentId` string, required
        - `id` string, required
        - `status` 'canceled', required

## Changes

- **2026-07-01** `dd47cd444fb3`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/rye-com/apis/universal-checkout-api/changes/api/v1/test-helpers/checkout-intents/:checkoutIntentId/shipments/advance/post.md)

---

[API](https://skmtc.dev/rye-com/apis/universal-checkout-api.md) - [All operations](https://skmtc.dev/rye-com/apis/universal-checkout-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rye-com/apis/universal-checkout-api/revisions/175c7f9e090e?raw)