---
title: "Update Inbound Shipment"
method: PATCH
path: "/api/v1/admin/inbound-shipments/{inbound_shipment_id}"
tags: ["admin-shipping-logistics"]
---

# Update Inbound Shipment

`PATCH /api/v1/admin/inbound-shipments/{inbound_shipment_id}`

## Path parameters

- `inbound_shipment_id` string, uuid, required

## Request body

- InboundShipmentUpdate
  - `carrier` 'ups' | 'dhl' | 'fedex' | 'usps' | 'other'
  - `tracking_number` string, nullable
  - `tracking_url` string, nullable
  - `status` 'pending' | 'processing' | 'ready_to_ship' | 'shipped' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'failed_delivery' | 'returned' | 'cancelled'
  - `estimated_delivery` string, date, nullable
  - `actual_delivery` string, date, nullable
  - `last_known_location` string, nullable

## Response `200`

Successful Response

- InboundShipmentResponse
  - `id` string, uuid, required
  - `project_id` string, uuid, required
  - `supplier_order_id` string, uuid, required
  - `supplier_contact_id` string, uuid, required
  - `carrier` 'ups' | 'dhl' | 'fedex' | 'usps' | 'other', required
  - `tracking_number` string, required
  - `tracking_url` string, nullable
  - `status` 'pending' | 'processing' | 'ready_to_ship' | 'shipped' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'failed_delivery' | 'returned' | 'cancelled', required
  - `estimated_delivery` string, date, nullable
  - `actual_delivery` string, date, nullable
  - `last_known_location` string, nullable
  - `origin_location` string, nullable
  - `destination_location` string, nullable
  - `service_name` string, nullable
  - `last_synced_at` string, date-time, nullable
  - `sync_status` 'never_synced' | 'syncing' | 'synced' | 'failed', required
  - `sync_error` string, nullable
  - `packages` InboundPackageResponse[]
    - `id` string, uuid, required
    - `inbound_shipment_id` string, uuid, required
    - `package_index` integer, required
    - `carrier_piece_id` string, nullable
    - `tracking_number` string, nullable
    - `weight` string, nullable
    - `weight_unit` string, nullable
    - `length` string, nullable
    - `width` string, nullable
    - `height` string, nullable
    - `dimension_unit` string, nullable
    - `description` string, nullable
  - `events` InboundShipmentEventResponse[]
    - `id` string, uuid, required
    - `inbound_shipment_id` string, uuid, required
    - `carrier_event_id` string, nullable
    - `status` 'pending' | 'processing' | 'ready_to_ship' | 'shipped' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'failed_delivery' | 'returned' | 'cancelled', required
    - `description` string, required
    - `location` string, nullable
    - `occurred_at` string, date-time, required
    - `created_at` string, date-time, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/prototyping/apis/prototyping-io-api.md) · [All operations](https://skmtc.dev/prototyping/apis/prototyping-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/prototyping/prototyping-io-api/revisions/f4a0079fbb57/schema)