BigCommerce · Schema

AdjustRequest

An **AdjustRequest** contains the same data as a standard **QuoteRequest** with added detail of the adjustment operation.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS
View JSON Schema on GitHub

JSON Schema

bigcommerce-request-adjust-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/request-adjust",
  "title": "AdjustRequest",
  "description": "An **AdjustRequest** contains the same data as a standard **QuoteRequest** with added detail of the adjustment operation.",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "adjust_description": {
          "type": "string",
          "description": "Specifies the reason for the adjustment operation, for auditing purposes. May be a custom, user-entered description."
        }
      }
    },
    {
      "$ref": "#/components/schemas/request-quote"
    }
  ],
  "x-internal": false
}