UpdateShipmentStatusRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-seller-central/main/json-schema/amazon-seller-central-update-shipment-status-request-schema.json",
  "title": "UpdateShipmentStatusRequest",
  "description": "The request body for the `updateShipmentStatus` operation.",
  "x-generated": "2026-09-24",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-seller-central-shipment-api-openapi.yml#/components/schemas/UpdateShipmentStatusRequest",
  "type": "object",
  "properties": {
    "marketplaceId": {
      "$ref": "#/$defs/MarketplaceId"
    },
    "shipmentStatus": {
      "$ref": "#/$defs/ShipmentStatus"
    },
    "orderItems": {
      "$ref": "#/$defs/OrderItems"
    }
  },
  "required": [
    "marketplaceId",
    "shipmentStatus"
  ],
  "$defs": {
    "MarketplaceId": {
      "description": "The unobfuscated marketplace identifier.",
      "type": "string"
    },
    "OrderItems": {
      "description": "For partial shipment status updates, the list of order items and quantities to be updated.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "orderItemId": {
            "description": "The order item's unique identifier.",
            "type": "string"
          },
          "quantity": {
            "type": "integer",
            "description": "The quantity for which to update the shipment status."
          }
        }
      }
    },
    "ShipmentStatus": {
      "description": "The shipment status to apply.",
      "type": "string",
      "enum": [
        "ReadyForPickup",
        "PickedUp",
        "RefusedPickup"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "ReadyForPickup",
          "description": "Ready for pickup."
        },
        {
          "value": "PickedUp",
          "description": "Picked up."
        },
        {
          "value": "RefusedPickup",
          "description": "Refused pickup."
        }
      ]
    }
  }
}