ShipmentExceptionCreate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/artashippinginc/json-schema/artashippinginc-shipment-exception-create-schema.json",
  "title": "ShipmentExceptionCreate",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/artashippinginc-shipment-exceptions-api-openapi.yml#/components/schemas/ShipmentExceptionCreate",
  "properties": {
    "shipment_exception": {
      "properties": {
        "hold_until": {
          "description": "Optionally provide a date to hold collection for the shipment. Values should be in the `YYYY-MM-DD` format. Hold until dates must be fewer than 30 days from the shipment's `created_at` datetime.",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "shipment_id": {
          "description": "The ID for the shipment associated to the shipment exception",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "type": {
          "description": "The type ID for this resource. Options are defined in the Shipment Exception Types metadata endpoint. Currently, the only accepted type for client-created shipment exceptions is `requested_hold_to_collect`.",
          "enum": [
            "requested_hold_to_collect"
          ],
          "type": "string",
          "x-struct": null,
          "x-validate": null
        }
      },
      "required": [
        "type",
        "shipment_id"
      ],
      "type": "object",
      "x-struct": null,
      "x-validate": null
    }
  },
  "required": [
    "shipment_exception"
  ],
  "type": "object",
  "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.ShipmentExceptionCreate",
  "x-validate": null
}