> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reap.global/llms.txt
> Use this file to discover all available pages before exploring further.

# Simulate shipment 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`.



## OpenAPI

````yaml /api-reference/openapi.json post /simulation/card-shipments/{id}/status
openapi: 3.1.0
info:
  title: Reap API
  version: 1.0.0
  description: Reap platform API
servers:
  - url: https://sg.sandbox.api.reap.global
    description: Singapore sandbox
  - url: https://sg.prod.api.reap.global
    description: Singapore production
  - url: https://mx.sandbox.api.reap.global
    description: Mexico sandbox
  - url: https://mx.prod.api.reap.global
    description: Mexico production
  - url: https://sandbox.api.reap.global
    description: Singapore sandbox (alias)
  - url: https://prod.api.reap.global
    description: Singapore production (alias)
security:
  - bearerAuth: []
tags:
  - name: Accounts
  - name: Activities
  - name: Card Designs
  - name: Card Shipments
  - name: Card Transactions
  - name: Cards
  - name: Companies
  - name: Crypto Deposits
  - name: Crypto Withdrawals
  - name: Disputes
  - name: Fiat Deposits
  - name: Fraud Alerts
  - name: Policies
  - name: Simulation
  - name: Users
  - name: Virtual Asset Postings
  - name: Virtual Assets
  - name: Webhooks
  - name: Agentic
paths:
  /simulation/card-shipments/{id}/status:
    post:
      tags:
        - Simulation
      summary: Simulate shipment status
      description: >-
        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`.
      operationId: cardShipmentStatus_simulation
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: Reap-Version
          in: header
          required: true
          schema:
            type: string
            enum:
              - '2025-02-14'
            description: API version (YYYY-MM-DD)
            example: '2025-02-14'
      requestBody:
        description: Simulate a card shipment status change
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - IN_PRODUCTION
                    - READY_TO_SHIP
                    - IN_TRANSIT
                    - OUT_FOR_DELIVERY
                    - DELIVERED
                    - DELIVERY_FAILED
                    - EXCEPTION
                    - CANCELED
                  description: Target shipment status to simulate
                  example: IN_PRODUCTION
              required:
                - status
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - IN_PRODUCTION
                    - READY_TO_SHIP
                    - IN_TRANSIT
                    - OUT_FOR_DELIVERY
                    - DELIVERED
                    - DELIVERY_FAILED
                    - EXCEPTION
                    - CANCELED
                  description: Target shipment status to simulate
                  example: IN_PRODUCTION
              required:
                - status
          multipart/form-data:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - IN_PRODUCTION
                    - READY_TO_SHIP
                    - IN_TRANSIT
                    - OUT_FOR_DELIVERY
                    - DELIVERED
                    - DELIVERY_FAILED
                    - EXCEPTION
                    - CANCELED
                  description: Target shipment status to simulate
                  example: IN_PRODUCTION
              required:
                - status
      responses:
        '204':
          description: Response for status 204
        '400':
          description: The resource is not in a valid state for the requested simulation
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        const: SIMULATION_INVALID_STATE
                      message:
                        type: string
                      detail:
                        anyOf:
                          - type: object
                            additionalProperties: {}
                          - type: 'null'
                    required:
                      - code
                      - message
                      - detail
                required:
                  - error
                title: SimulationInvalidStateError
        '404':
          description: Card shipment not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        const: CARD_SHIPMENT_NOT_FOUND
                      message:
                        type: string
                      detail:
                        anyOf:
                          - type: object
                            additionalProperties: {}
                          - type: 'null'
                    required:
                      - code
                      - message
                      - detail
                required:
                  - error
                title: SimulationCardShipmentNotFoundError
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key as Bearer token

````