{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/bol-com/json-schema/bol-com-shipping-label-request-schema.json",
  "title": "ShippingLabelRequest",
  "description": "The configuration of order items to get delivery options for.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bol-com-shipping-labels-api-openapi.yml#/components/schemas/ShippingLabelRequest",
  "required": [
    "orderItems",
    "shippingLabelOfferId"
  ],
  "type": "object",
  "properties": {
    "orderItems": {
      "minItems": 1,
      "type": "array",
      "description": "Order items for which the delivery options are requested.",
      "items": {
        "$ref": "#/$defs/DeliveryOptionsRequestOrderItem"
      }
    },
    "shippingLabelOfferId": {
      "minLength": 1,
      "type": "string",
      "description": "Shipping label offer id for which you request a shipping label."
    }
  },
  "$defs": {
    "DeliveryOptionsRequestOrderItem": {
      "required": [
        "orderItemId"
      ],
      "type": "object",
      "properties": {
        "orderItemId": {
          "minLength": 1,
          "type": "string",
          "description": "The id for the order item (1 order can have multiple order items)."
        },
        "quantity": {
          "type": [
            "integer",
            "null"
          ],
          "description": "The quantity of the order item for which the shipping label creation is requested for. If omitted, will be interpreted as the full quantity that is still open for this order item.",
          "format": "int32",
          "exclusiveMinimum": 0
        }
      },
      "description": "Order items for which the delivery options are requested."
    }
  }
}