---
title: "Update a shipment"
method: PUT
path: "/shipping/{connection_id}/shipment/{id}"
tags: ["shipping", "shipment"]
---

# Update a shipment

`PUT /shipping/{connection_id}/shipment/{id}`

## Path parameters

- `connection_id` string, required
- `id` string, required

## Query parameters

- `fields` string[]
- `raw` string

## Request body

- ShippingShipment
  - `id` string
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `order_id` string
  - `from_address` PropertyShippingShipmentFromAddress — Origin address
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string
    - `region_code` string
    - `postal_code` string
    - `country` string
    - `country_code` string
    - `name` string
    - `company_name` string
    - `telephone` string
    - `email` string
    - `is_residential` boolean
    - `is_validated` boolean
    - `delivery_instructions` string
  - `to_address` PropertyShippingShipmentToAddress — Destination address
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string
    - `region_code` string
    - `postal_code` string
    - `country` string
    - `country_code` string
    - `name` string
    - `company_name` string
    - `telephone` string
    - `email` string
    - `is_residential` boolean
    - `is_validated` boolean
    - `delivery_instructions` string
  - `packages` ShippingPackage[] — Array of packages in this shipment
    - `weight` number
    - `weight_unit` 'g' | 'kg' | 'oz' | 'lb'
    - `length` number
    - `width` number
    - `height` number
    - `size_unit` 'cm' | 'inch'
    - `description` string
    - `value` number
    - `currency` string
    - `tracking_number` string
    - `insured_amount` number
  - `carrier_id` string
  - `service_code` string
  - `status` 'PENDING' | 'PROCESSING' | 'IN_TRANSIT' | 'DELIVERED' | 'EXCEPTION' | 'CANCELLED' | 'LABEL_CREATED' | 'PICKED_UP' | 'OUT_FOR_DELIVERY' | 'DELIVERY_ATTEMPTED' | 'RETURNED_TO_SENDER' | 'HELD_AT_LOCATION' | 'CUSTOMS_CLEARANCE' | 'EXCEPTION_RESOLVED'
  - `rate_id` string
  - `label_id` string
  - `tracking_id` string
  - `shipped_at` string, date-time
  - `rate_amount` number
  - `rate_currency` string
  - `rate_service_name` string
  - `rate_estimated_days` number
  - `rate_estimated_delivery_at` string, date-time
  - `is_rate_guaranteed` boolean
  - `return_address` PropertyShippingShipmentReturnAddress — Return address (may differ from from_address)
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string
    - `region_code` string
    - `postal_code` string
    - `country` string
    - `country_code` string
    - `name` string
    - `company_name` string
    - `telephone` string
    - `email` string
    - `is_residential` boolean
    - `is_validated` boolean
    - `delivery_instructions` string
  - `return_authorization_number` string
  - `warehouse_location_id` string
  - `warehouse_location_name` string
  - `customs` PropertyShippingShipmentCustoms — Customs information
    - `contents_type` 'MERCHANDISE' | 'DOCUMENTS' | 'GIFT' | 'RETURNED_GOODS' | 'SAMPLE' | 'OTHER'
    - `description` string
    - `amount` number
    - `currency` string
    - `duties_paid_by` 'SENDER' | 'RECIPIENT' | 'THIRD_PARTY'
    - `taxes_paid_by` 'SENDER' | 'RECIPIENT' | 'THIRD_PARTY'
    - `shipper_eori` string
    - `recipient_eori` string
    - `shipper_tax_number` string
    - `recipient_tax_number` string
    - `items` ShippingCustomsItem[] — Customs items
      - `description` string
      - `quantity` number
      - `amount` number
      - `currency` string
      - `weight` number
      - `weight_unit` 'g' | 'kg' | 'oz' | 'lb'
      - `harmonized_tariff_code` string
      - `country_of_origin` string
      - `sku` string
    - `restrictions` string[] — Any restrictions
    - `non_delivery_option` 'RETURN' | 'ABANDON'
  - `is_international` boolean
  - `insurance` PropertyShippingShipmentInsurance — Insurance details
    - `insured_value` number
    - `currency` string
    - `insurance_provider` string
    - `insurance_provider_code` string
    - `insurance_cost` number
    - `insurance_cost_currency` string
    - `coverage_type` 'STANDARD' | 'PREMIUM' | 'CUSTOM'
    - `coverage_amount` number
  - `special_instructions` string[] — Array of special instructions
  - `is_signature_required` boolean
  - `is_adult_signature_required` boolean
  - `reference_number` string
  - `is_return` boolean
  - `original_shipment_id` string
  - `return_reason` string
  - `return_type` 'CUSTOMER' | 'VENDOR' | 'WARRANTY' | 'DEFECTIVE' | 'OTHER'
  - `raw` object

## Response `200`

Successful

- ShippingShipment
  - `id` string
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `order_id` string
  - `from_address` PropertyShippingShipmentFromAddress — Origin address
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string
    - `region_code` string
    - `postal_code` string
    - `country` string
    - `country_code` string
    - `name` string
    - `company_name` string
    - `telephone` string
    - `email` string
    - `is_residential` boolean
    - `is_validated` boolean
    - `delivery_instructions` string
  - `to_address` PropertyShippingShipmentToAddress — Destination address
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string
    - `region_code` string
    - `postal_code` string
    - `country` string
    - `country_code` string
    - `name` string
    - `company_name` string
    - `telephone` string
    - `email` string
    - `is_residential` boolean
    - `is_validated` boolean
    - `delivery_instructions` string
  - `packages` ShippingPackage[] — Array of packages in this shipment
    - `weight` number
    - `weight_unit` 'g' | 'kg' | 'oz' | 'lb'
    - `length` number
    - `width` number
    - `height` number
    - `size_unit` 'cm' | 'inch'
    - `description` string
    - `value` number
    - `currency` string
    - `tracking_number` string
    - `insured_amount` number
  - `carrier_id` string
  - `service_code` string
  - `status` 'PENDING' | 'PROCESSING' | 'IN_TRANSIT' | 'DELIVERED' | 'EXCEPTION' | 'CANCELLED' | 'LABEL_CREATED' | 'PICKED_UP' | 'OUT_FOR_DELIVERY' | 'DELIVERY_ATTEMPTED' | 'RETURNED_TO_SENDER' | 'HELD_AT_LOCATION' | 'CUSTOMS_CLEARANCE' | 'EXCEPTION_RESOLVED'
  - `rate_id` string
  - `label_id` string
  - `tracking_id` string
  - `shipped_at` string, date-time
  - `rate_amount` number
  - `rate_currency` string
  - `rate_service_name` string
  - `rate_estimated_days` number
  - `rate_estimated_delivery_at` string, date-time
  - `is_rate_guaranteed` boolean
  - `return_address` PropertyShippingShipmentReturnAddress — Return address (may differ from from_address)
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string
    - `region_code` string
    - `postal_code` string
    - `country` string
    - `country_code` string
    - `name` string
    - `company_name` string
    - `telephone` string
    - `email` string
    - `is_residential` boolean
    - `is_validated` boolean
    - `delivery_instructions` string
  - `return_authorization_number` string
  - `warehouse_location_id` string
  - `warehouse_location_name` string
  - `customs` PropertyShippingShipmentCustoms — Customs information
    - `contents_type` 'MERCHANDISE' | 'DOCUMENTS' | 'GIFT' | 'RETURNED_GOODS' | 'SAMPLE' | 'OTHER'
    - `description` string
    - `amount` number
    - `currency` string
    - `duties_paid_by` 'SENDER' | 'RECIPIENT' | 'THIRD_PARTY'
    - `taxes_paid_by` 'SENDER' | 'RECIPIENT' | 'THIRD_PARTY'
    - `shipper_eori` string
    - `recipient_eori` string
    - `shipper_tax_number` string
    - `recipient_tax_number` string
    - `items` ShippingCustomsItem[] — Customs items
      - `description` string
      - `quantity` number
      - `amount` number
      - `currency` string
      - `weight` number
      - `weight_unit` 'g' | 'kg' | 'oz' | 'lb'
      - `harmonized_tariff_code` string
      - `country_of_origin` string
      - `sku` string
    - `restrictions` string[] — Any restrictions
    - `non_delivery_option` 'RETURN' | 'ABANDON'
  - `is_international` boolean
  - `insurance` PropertyShippingShipmentInsurance — Insurance details
    - `insured_value` number
    - `currency` string
    - `insurance_provider` string
    - `insurance_provider_code` string
    - `insurance_cost` number
    - `insurance_cost_currency` string
    - `coverage_type` 'STANDARD' | 'PREMIUM' | 'CUSTOM'
    - `coverage_amount` number
  - `special_instructions` string[] — Array of special instructions
  - `is_signature_required` boolean
  - `is_adult_signature_required` boolean
  - `reference_number` string
  - `is_return` boolean
  - `original_shipment_id` string
  - `return_reason` string
  - `return_type` 'CUSTOMER' | 'VENDOR' | 'WARRANTY' | 'DEFECTIVE' | 'OTHER'
  - `raw` object

---

[API](https://skmtc.net/unified/apis/unified-to-api.md) · [All operations](https://skmtc.net/unified/apis/unified-to-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unified/unified-to-api/versions/1f72720916e4/schema)