{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/bol-com/json-schema/bol-com-delivery-options-response-schema.json",
  "title": "DeliveryOptionsResponse",
  "description": "The possible delivery options based on a shippable configuration",
  "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/DeliveryOptionsResponse",
  "required": [
    "deliveryOptions"
  ],
  "type": "object",
  "properties": {
    "deliveryOptions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/DeliveryOption"
      }
    }
  },
  "$defs": {
    "DeliveryOption": {
      "required": [
        "labelDisplayName",
        "labelPrice",
        "labelType",
        "packageRestrictions",
        "recommended",
        "shippingLabelOfferId",
        "transporterCode"
      ],
      "type": "object",
      "properties": {
        "shippingLabelOfferId": {
          "type": "string",
          "description": "Unique identifier for the shipping label offer."
        },
        "recommended": {
          "type": "boolean",
          "description": "Indicates whether this delivery option is recommended to be the best option to ship your order item(s) with."
        },
        "validUntilDate": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date until the delivery option (incl total price) is valid.",
          "format": "date"
        },
        "transporterCode": {
          "type": "string",
          "description": "A code representing the transporter which is being used for transportation."
        },
        "labelType": {
          "type": "string",
          "description": "The type of the label, representing the way an item is being transported. MAILBOX is a mailbox package with delivery scan. MAILBOX_LIGHT is a mailbox package without delivery scan. PARCEL is a normal package.",
          "enum": [
            "PARCEL",
            "MAILBOX",
            "MAILBOX_LIGHT"
          ]
        },
        "labelDisplayName": {
          "type": "string",
          "description": "The display name of the shipping label."
        },
        "labelPrice": {
          "$ref": "#/$defs/LabelPrice"
        },
        "packageRestrictions": {
          "$ref": "#/$defs/PackageRestrictions"
        },
        "handoverDetails": {
          "allOf": [
            {
              "$ref": "#/$defs/HandoverDetails"
            }
          ]
        }
      },
      "description": "A delivery option shows how and the costs of a transport for a shippable configuration"
    },
    "HandoverDetails": {
      "type": "object",
      "properties": {
        "meetsCustomerExpectation": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Indicates if you can use this label without receiving a strike if you handover before the latestHandoverDateTime. If this field is 'false' you can still buy and use this label but it will have negative consequences on your performance score because the order will be delivered too early or too late."
        },
        "earliestHandoverDateTime": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date and time at which the parcel can be earliest  at the transporter to make sure your parcel is delivered on time.",
          "format": "date-time"
        },
        "latestHandoverDateTime": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date and time at which the parcel must ultimately be at the transporter to make sure your parcel is delivered on time. If you handover after this date you will receive a strike because you order will be delivered too late.",
          "format": "date-time"
        },
        "collectionMethod": {
          "type": [
            "string",
            "null"
          ],
          "description": "The type of collection for this parcel.",
          "enum": [
            "DROP_OFF",
            "PICK_UP",
            null
          ]
        }
      }
    },
    "LabelPrice": {
      "required": [
        "totalPrice"
      ],
      "type": "object",
      "properties": {
        "totalPrice": {
          "type": "number",
          "description": "The price that is charged for this delivery option, excluding VAT."
        }
      }
    },
    "PackageRestrictions": {
      "required": [
        "maxDimensions",
        "maxWeight"
      ],
      "type": "object",
      "properties": {
        "maxWeight": {
          "type": "string",
          "description": "The weight of a package."
        },
        "maxDimensions": {
          "type": "string",
          "description": "The dimensions of a package."
        }
      }
    }
  }
}