Partial Packing Slip Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed/main/json-schema/lightspeed-partial-packing-slip-request-schema.json",
  "title": "Partial Packing Slip Request",
  "description": "Request body describing the subset of line items and quantities to render on a partial packing slip",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lightspeed-packing-slips-api-openapi.yml#/components/schemas/PartialPackingSlipRequest",
  "properties": {
    "lang": {
      "description": "BCP 47 language tag used to localize the static template strings on the packing slip. Defaults to `en-US` when omitted or unrecognized.",
      "type": "string"
    },
    "packed_line_items": {
      "description": "The sale line items and quantities to include on the partial packing slip. Must contain at least one item.",
      "items": {
        "$ref": "#/$defs/PackedLineItem"
      },
      "minItems": 1,
      "type": "array"
    }
  },
  "required": [
    "packed_line_items"
  ],
  "type": "object",
  "$defs": {
    "PackedLineItem": {
      "description": "A single sale line item and the quantity to include on the partial packing slip",
      "properties": {
        "quantity": {
          "description": "The quantity of this line item to pack. Must be a positive finite number and must not exceed the quantity already packed on the pick lists.",
          "format": "double",
          "type": "number"
        },
        "sale_line_item_id": {
          "description": "The ID of the sale line item to include on the packing slip",
          "format": "uuid",
          "type": "string"
        }
      },
      "required": [
        "sale_line_item_id",
        "quantity"
      ],
      "title": "Packed Line Item",
      "type": "object"
    }
  }
}