BigCommerce · Schema

GetReturnableItems

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS
View JSON Schema on GitHub

JSON Schema

bigcommerce-getreturnableitems-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetReturnableItems",
  "title": "GetReturnableItems",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "reference_id": {
        "$ref": "#/components/schemas/ItemReferenceId"
      },
      "name": {
        "type": "string",
        "description": "The name of the order product."
      },
      "returnable_quantity": {
        "type": "integer",
        "description": "The maximum quantity of this item that can presently be requested for return."
      },
      "total": {
        "type": "string",
        "format": "decimal",
        "description": "The total price of this line item."
      },
      "options": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "display_name": {
              "type": "string",
              "description": "A displayable name for the option."
            },
            "display_value": {
              "type": "string",
              "description": "A displayable value for the option."
            }
          },
          "description": "An item available for return."
        },
        "description": "A collection of options configured for the order product."
      }
    }
  },
  "x-internal": false
}