TaxableOrder

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/kibo-commerce/main/json-schema/kibo-commerce-taxable-order-schema.json",
  "title": "TaxableOrder",
  "description": "Properties of a taxable order",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/kibo-commerce-pricing-openapi.yml#/components/schemas/TaxableOrder",
  "properties": {
    "attributes": {
      "items": {
        "$ref": "#/$defs/TaxAttribute"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "currencyCode": {
      "description": "The currency code for this order",
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ]
    },
    "handlingDiscount": {
      "$ref": "#/$defs/PricingRuntimeAppliedDiscount"
    },
    "handlingDiscounts": {
      "description": "The list of historically-applied handling discounts.  The active one will have IsExcluded == false",
      "items": {
        "$ref": "#/$defs/PricingRuntimeAppliedDiscount"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "handlingFee": {
      "description": "Handling Fee",
      "format": "double",
      "type": "number"
    },
    "lineItems": {
      "description": "List of taxable items.",
      "items": {
        "$ref": "#/$defs/TaxableLineItem"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "orderDate": {
      "description": "Date on which the order is/was submitted.\nCannot be a future date.",
      "format": "date-time",
      "type": "string"
    },
    "orderDiscount": {
      "$ref": "#/$defs/PricingRuntimeAppliedDiscount"
    },
    "orderDiscounts": {
      "description": "The discount that has been applied to the cart itself. If multiple discounts exist, this is the discount that the system applies because it offers the best savings for the shopper. This is a negative number.",
      "items": {
        "$ref": "#/$defs/PricingRuntimeAppliedDiscount"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "orderId": {
      "type": [
        "string",
        "null"
      ]
    },
    "orderNumber": {
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "originalDocumentCode": {
      "description": "The order id of the original order.  This can be used to track changes to the order for taxing purposes.",
      "type": [
        "string",
        "null"
      ]
    },
    "originalOrderDate": {
      "description": "The date of the original order.  This is used when calculating changes to the Taxable Order, evaluating them at this time rather than the present.",
      "format": "date-time",
      "type": "string"
    },
    "shippingAmount": {
      "description": "Shipping Amount rolled up for the order",
      "format": "double",
      "type": "number"
    },
    "shippingDiscount": {
      "$ref": "#/$defs/AppliedOrderShippingDiscount"
    },
    "shippingDiscounts": {
      "description": "The list of historically-applied shipping discounts.  The active one will have IsExcluded == false",
      "items": {
        "$ref": "#/$defs/AppliedOrderShippingDiscount"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "shippingMethodCode": {
      "description": "Code that uniquely identifies the shipping method such as \"Ground,\" \"Overnight,\" or \"Digital.\"\nThe site's shipping settings lists the valid shipping methods specified for this site.",
      "type": [
        "string",
        "null"
      ]
    },
    "shippingMethodName": {
      "description": "Readable name of the shipping method",
      "type": [
        "string",
        "null"
      ]
    },
    "taxContext": {
      "$ref": "#/$defs/TaxContext"
    },
    "taxRequestType": {
      "description": "Used to differentiate between an Order and a Return being used as the source of this Taxable Order",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "type": "object",
  "$defs": {
    "Address": {
      "properties": {
        "address1": {
          "type": [
            "string",
            "null"
          ]
        },
        "address2": {
          "type": [
            "string",
            "null"
          ]
        },
        "address3": {
          "type": [
            "string",
            "null"
          ]
        },
        "address4": {
          "type": [
            "string",
            "null"
          ]
        },
        "addressType": {
          "type": [
            "string",
            "null"
          ]
        },
        "cityOrTown": {
          "type": [
            "string",
            "null"
          ]
        },
        "countryCode": {
          "type": [
            "string",
            "null"
          ]
        },
        "isValidated": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "postalOrZipCode": {
          "type": [
            "string",
            "null"
          ]
        },
        "stateOrProvince": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "AppliedOrderShippingDiscount": {
      "properties": {
        "couponCode": {
          "description": "Code of the coupon associated with the discount (if a coupon code is required in order to receive the discount).",
          "type": [
            "string",
            "null"
          ]
        },
        "couponSetId": {
          "description": "Contains coupon set id if there is one",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "discount": {
          "$ref": "#/$defs/PricingRuntimeDiscount2"
        },
        "impact": {
          "description": "Value of the discount, that is how much the shopper saves if discount is applied.",
          "format": "double",
          "type": "number"
        },
        "shippingMethodCode": {
          "description": "Unique identifier of the shipping method discount.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "DiscountCondition": {
      "properties": {
        "couponCode": {
          "description": "ShippingMethodCode of the coupon associated with the discount (if a coupon code is required). The merchant can supply the code or the system can generate it.",
          "type": [
            "string",
            "null"
          ]
        },
        "customerSegmentIds": {
          "description": "List of customer groups for which the discount applies",
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "excludedCategoryIds": {
          "description": "List of categories to discount. When a discount applies to a category, all products in the category are discounted.",
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "excludedProductCodes": {
          "description": "List of products that are eligible for the discount.",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "expirationDate": {
          "description": "Date when the discount expires. Default is null (no expiration date).",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "includedCategoryIds": {
          "description": "List of categories to discount. When a discount applies to a category, all products in the category are discounted.",
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "includedProductCodes": {
          "description": "List of products that are eligible for the discount.",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "maximumOrderAmount": {
          "description": "If the discount is for products, how many product can you have and still be eligible for the discount.\nIf the discount is for an order, what is the max the order can total to be eligible for the discount. For example, you might want to offer a 10% discount on orders under $100.",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "minDistinctProductsRequired": {
          "description": "Minimum number of distinct products that must be purchased that are also not free.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "minimumCategorySubtotalBeforeDiscounts": {
          "description": "Minimum amount that must be purchased in the combined categories defined in \nIncludedCategories.  Amount is calculated before discounting.",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "minimumLifetimeValueAmount": {
          "description": "Minimum lifetime value amount required for this discount to apply",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "minimumOrderAmount": {
          "description": "If the discount is for products, how many products must be purchased to be eligible for the discount.\nIf the discount is for an order, how much the order must total to be eligible for the discount. For example, you might want to offer a 10% discount on orders over $100.",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "minimumQuantityProductsRequiredInCategories": {
          "description": "Minimum quantity of products in the categories specified in IncludedCategories that must be purchased to\nqualify for the associated discount.\nValid values are null and ints greater than zero",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "minimumQuantityRequiredProducts": {
          "description": "Minimum quantity of products in the specified IncludedProducts that must be purchased to\nqualify for the associated discount.\nDefaults to 0",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "paymentWorkflows": {
          "description": "List of payment types that are valid for this discount.\nAn empty list signifies all payment types.",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "requiresCoupon": {
          "description": "If true, the shopper needs to enter a coupon code to redeem the discount.",
          "type": "boolean"
        },
        "startDate": {
          "description": "Date when the discount can goes into effect, in the format yyyy-mm-dd.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "DiscountTarget": {
      "properties": {
        "excludedCategoriesOperator": {
          "type": [
            "string",
            "null"
          ]
        },
        "excludedCategoryIds": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "excludedProductCodes": {
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "includeAllProducts": {
          "description": "When IncludeAllProducts is true then IncludedCategories and IncludedProducts are not evaluated and should be \nempty.  Only exclusions apply.",
          "type": "boolean"
        },
        "includedCategoriesOperator": {
          "type": [
            "string",
            "null"
          ]
        },
        "includedCategoryIds": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "includedProductCodes": {
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "shippingMethods": {
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "shippingZones": {
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "type": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "PricingRuntimeAppliedDiscount": {
      "description": "Details of the applied discount, including how much the shopper saves if the discount is applied and the coupon\ncode\nrequired to redeem the discount, if any.",
      "properties": {
        "couponCode": {
          "description": "Code of the coupon associated with the discount (if a coupon code is required in order to receive the discount).",
          "type": [
            "string",
            "null"
          ]
        },
        "couponSetId": {
          "description": "Contains coupon set id if there is one",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "discount": {
          "$ref": "#/$defs/PricingRuntimeDiscount2"
        },
        "impact": {
          "description": "Value of the discount, that is how much the shopper saves if discount is applied.",
          "format": "double",
          "type": "number"
        }
      },
      "type": "object"
    },
    "PricingRuntimeAppliedLineItemProductDiscount": {
      "properties": {
        "appliesToSalePrice": {
          "description": "Indicates that this discount is to be applied to the sale price if true or the list price if false.\nThis only applies to product and line item discounts.",
          "type": "boolean"
        },
        "couponCode": {
          "description": "Code of the coupon associated with the discount (if a coupon code is required in order to receive the discount).",
          "type": [
            "string",
            "null"
          ]
        },
        "couponSetId": {
          "description": "Contains coupon set id if there is one",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "discount": {
          "$ref": "#/$defs/PricingRuntimeDiscount2"
        },
        "impact": {
          "description": "Value of the discount, that is how much the shopper saves if discount is applied.",
          "format": "double",
          "type": "number"
        },
        "impactPerUnit": {
          "description": "Discount impact per unit for the quantity applied.\nThis value is not rounded.\nImpactPerUnit * Quantity = Impact @ Quantity",
          "format": "double",
          "type": "number"
        },
        "isForced": {
          "description": "Signifies that the discount is forced and not applied via best match.",
          "type": "boolean"
        },
        "normalizedImpact": {
          "format": "double",
          "type": "number"
        },
        "quantity": {
          "description": "Quantity of items from the line item that the discount applies to.",
          "format": "int32",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "PricingRuntimeAppliedLineItemShippingDiscount": {
      "properties": {
        "couponCode": {
          "description": "Code of the coupon associated with the discount (if a coupon code is required in order to receive the discount).",
          "type": [
            "string",
            "null"
          ]
        },
        "couponSetId": {
          "description": "Contains coupon set id if there is one",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "discount": {
          "$ref": "#/$defs/PricingRuntimeDiscount2"
        },
        "impact": {
          "description": "Value of the discount, that is how much the shopper saves if discount is applied.",
          "format": "double",
          "type": "number"
        },
        "impactPerUnit": {
          "description": "Discount impact per unit for the quantity applied.\nThis value is not rounded.\nImpactPerUnit * Quantity = Impact @ Quantity",
          "format": "double",
          "type": "number"
        },
        "isForced": {
          "description": "Signifies that the discount is forced and not applied via best match.",
          "type": "boolean"
        },
        "normalizedImpact": {
          "format": "double",
          "type": "number"
        },
        "quantity": {
          "description": "Quantity of items from the line item that the discount applies to.",
          "format": "int32",
          "type": "integer"
        },
        "shippingMethodCode": {
          "description": "Unique identifier of the shipping method discount.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "PricingRuntimeDiscount2": {
      "description": "Name of the discount that can be applied and its expiration date. The discount can be on a single product or the\nentire order.",
      "properties": {
        "amount": {
          "format": "double",
          "type": "number"
        },
        "amountType": {
          "description": "Type of discount, which can be either a percentage off the price, a specific monetary amount, or free. Possible values: \"Percentage,\" \"Amount,\" and \"Free\".",
          "type": [
            "string",
            "null"
          ]
        },
        "code": {
          "description": "Unique identifier of the discount.",
          "type": [
            "string",
            "null"
          ]
        },
        "condition": {
          "$ref": "#/$defs/DiscountCondition"
        },
        "discountId": {
          "description": "Unique identifier of the discount. System-supplied and read-only.",
          "format": "int32",
          "type": "integer"
        },
        "doesNotApplyToMultiShipToOrders": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "doesNotApplyToProductsWithSalePrice": {
          "type": "boolean"
        },
        "expirationDate": {
          "deprecated": true,
          "description": "When the discount expires. If null, there's no expiration date.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "friendlyDescription": {
          "description": "Friendly description of the discount.",
          "type": [
            "string",
            "null"
          ]
        },
        "includedPriceLists": {
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "isPublic": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "labels": {
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "maxDiscountValuePerRedemption": {
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "maxRedemptions": {
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "maximumDiscountValuePerOrder": {
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "maximumRedemptionsPerOrder": {
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "maximumUsesPerUser": {
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "name": {
          "description": "Name of the discount.",
          "type": [
            "string",
            "null"
          ]
        },
        "redemptions": {
          "format": "int32",
          "type": "integer"
        },
        "requiresAuthenticatedUser": {
          "type": "boolean"
        },
        "scope": {
          "type": [
            "string",
            "null"
          ]
        },
        "stackingLayer": {
          "format": "int32",
          "type": "integer"
        },
        "target": {
          "$ref": "#/$defs/DiscountTarget"
        },
        "type": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "PricingRuntimeProductProperty": {
      "description": "Duplicate definition from ProductRuntime",
      "properties": {
        "attributeDetail": {
          "$ref": "#/$defs/ProductAttribute"
        },
        "attributeFQN": {
          "description": "Attribute fully qualified name",
          "type": [
            "string",
            "null"
          ]
        },
        "isHidden": {
          "description": "Indicates whether the product property should be hidden from the customer",
          "type": [
            "boolean",
            "null"
          ]
        },
        "isMultiValue": {
          "description": "Indicates whether it's possible for there to be more than one value in the Values field",
          "type": [
            "boolean",
            "null"
          ]
        },
        "values": {
          "description": "Value(s) of the product property",
          "items": {
            "$ref": "#/$defs/PricingRuntimeProductPropertyValue"
          },
          "type": [
            "array",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "PricingRuntimeProductPropertyValue": {
      "description": "Duplicate definition from ProductRuntime",
      "properties": {
        "stringValue": {
          "description": "Localized Value in the language of the locale code",
          "type": [
            "string",
            "null"
          ]
        },
        "value": {
          "nullable": true
        }
      },
      "type": "object"
    },
    "ProductAttribute": {
      "description": "Duplicate definition from ProductRuntime",
      "properties": {
        "dataType": {
          "description": "The DataType of the attribute. Valid values for DataType are defined in DataTypeTypeConst.",
          "type": [
            "string",
            "null"
          ]
        },
        "description": {
          "description": "Description of the attribute in the language specified by LocaleCode.",
          "type": [
            "string",
            "null"
          ]
        },
        "inputType": {
          "description": "The InputType type of the attribute. Valid values for InputType are defined in InputTypeConst.",
          "type": [
            "string",
            "null"
          ]
        },
        "name": {
          "description": "Name of the attribute in the language specified by LocaleCode.",
          "type": [
            "string",
            "null"
          ]
        },
        "valueType": {
          "description": "The ValueType of the attribute. Valid values for ValueType are defined in ValueTypeTypeConst.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "TaxAttribute": {
      "properties": {
        "attributeDefinitionId": {
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "fullyQualifiedName": {
          "type": [
            "string",
            "null"
          ]
        },
        "values": {
          "items": {},
          "type": [
            "array",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "TaxContext": {
      "description": "The context for the tax calculation.",
      "properties": {
        "customerId": {
          "description": "A unique id for a customer.  This may be the userid, checking with Avalara to determine the meaning of this",
          "type": [
            "string",
            "null"
          ]
        },
        "destinationAddress": {
          "$ref": "#/$defs/Address"
        },
        "originAddress": {
          "$ref": "#/$defs/Address"
        },
        "taxContextId": {
          "description": "The unique id of this context. Will typically be the OrderId or CartId, depending when the tax is being calculated.",
          "type": [
            "string",
            "null"
          ]
        },
        "taxExemptId": {
          "description": "Tax exemption id.  Indicates that this customer or user is tax exempt",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "TaxableLineItem": {
      "properties": {
        "data": {
          "type": [
            "object",
            "null"
          ]
        },
        "destinationAddress": {
          "$ref": "#/$defs/Address"
        },
        "discountTotal": {
          "description": "How much the shopper saves with the applied discount or sale price. This is a negative number.",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "discountedTotal": {
          "description": "Subtotal minus any discounts.",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "feeTotal": {
          "description": "Not implemented. Total cost of fees that apply to this item.",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "handlingAmount": {
          "description": "Handling Amount for this item",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "id": {
          "description": "Unique identifier of the line item.",
          "type": [
            "string",
            "null"
          ]
        },
        "isTaxable": {
          "description": "Is the Product taxable",
          "type": [
            "boolean",
            "null"
          ]
        },
        "lineItemPrice": {
          "description": "The line item subtotal of quantity * Product.TaxablePrice",
          "format": "double",
          "type": "number"
        },
        "originAddress": {
          "$ref": "#/$defs/Address"
        },
        "productCode": {
          "description": "Unique code of the product.",
          "type": [
            "string",
            "null"
          ]
        },
        "productDiscount": {
          "$ref": "#/$defs/PricingRuntimeAppliedLineItemProductDiscount"
        },
        "productDiscounts": {
          "description": "A list of discounts applied to the product",
          "items": {
            "$ref": "#/$defs/PricingRuntimeAppliedLineItemProductDiscount"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "productName": {
          "description": "Name of the product.",
          "type": [
            "string",
            "null"
          ]
        },
        "productProperties": {
          "description": "Custom Properties of the product (i.e. inclues TaxCode)",
          "items": {
            "$ref": "#/$defs/PricingRuntimeProductProperty"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "quantity": {
          "description": "The number of products for this line item",
          "format": "int32",
          "type": "integer"
        },
        "reason": {
          "description": "Clarifications on the reason this item is being taxed/returned?",
          "type": [
            "string",
            "null"
          ]
        },
        "shippingAmount": {
          "description": "The line item shipping amount.",
          "format": "double",
          "type": "number"
        },
        "shippingDiscount": {
          "$ref": "#/$defs/PricingRuntimeAppliedLineItemShippingDiscount"
        },
        "shippingDiscounts": {
          "description": "A discount applied to the shipping",
          "items": {
            "$ref": "#/$defs/PricingRuntimeAppliedLineItemShippingDiscount"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "variantProductCode": {
          "description": "For configurable products, the unique identifier of the product variation that has been selected.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    }
  }
}