BigCommerce · Schema

Quantity Bound Item

Quantity Bound Item Type of refund item that capture refunding of items in the order that are of type quantity. * `ORDER` * `PRODUCT` * `GIFT_WRAPPING` * `SHIPPING` * `HANDLING` * `TAX`

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
item_type string Type of refund.
item_id integer Order Product ID.
quantity integer
reason string Reason for refund.
View JSON Schema on GitHub

JSON Schema

bigcommerce-quantitybounditem-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/QuantityBoundItem",
  "title": "Quantity Bound Item",
  "type": "object",
  "description": "Quantity Bound Item\n\nType of refund item that capture refunding of items in the order that are of type quantity.\n* `ORDER`\n* `PRODUCT`\n* `GIFT_WRAPPING`\n* `SHIPPING`\n* `HANDLING`\n* `TAX`\n",
  "properties": {
    "item_type": {
      "type": "string",
      "example": "PRODUCT",
      "enum": [
        "ORDER",
        "PRODUCT",
        "GIFT_WRAPPING",
        "SHIPPING",
        "HANDLING",
        "TAX"
      ],
      "description": "Type of refund."
    },
    "item_id": {
      "type": "integer",
      "example": 1,
      "description": "Order Product ID."
    },
    "quantity": {
      "type": "integer",
      "example": 3
    },
    "reason": {
      "type": "string",
      "example": "Wrong size.",
      "description": "Reason for refund.",
      "minLength": 0,
      "maxLength": 1000
    }
  },
  "x-internal": false
}