Adjust Tax Quote | BigCommerce Developer Center

curl -X POST "https://your_app.example.com/adjust?id=id" \
     -H "X-Bc-Store-Hash: X-Bc-Store-Hash" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "currency_code": "string",
  "customer": {
    "customer_id": "string",
    "customer_group_id": "0"
  },
  "documents": [
    {
      "id": "string",
      "destination_address": {},
      "origin_address": {},
      "shipping": {
        "id": "string",
        "price": {
          "amount": 1.5,
          "tax_inclusive": false
        },
        "quantity": 1,
        "type": "shipping"
      },
      "handling": {
        "id": "string",
        "price": {
          "amount": 1.5,
          "tax_inclusive": false
        },
        "quantity": 1,
        "type": "handling"
      },
      "items": [
        {
          "id": "string",
          "price": {
            "amount": 1.5,
            "tax_inclusive": false
          },
          "quantity": 1,
          "type": "item"
        }
      ]
    }
  ],
  "id": "string",
  "transaction_date": "2024-01-15T09:30:00Z"
}'

{
  "id": "3f0c857e-2c55-443e-a89b-c3c4d8a29605",
  "documents": [
    {
      "id": "5d522b889d3d9",
      "items": [
        {
          "id": "088c7465-e5b8-4624-a220-0d9faa82e7cb",
          "price": {
            "amount_inclusive": 675,
            "amount_exclusive": 450,
            "total_tax": 225,
            "tax_rate": 0.5,
            "sales_tax_summary": [
              {
                "name": "Brutal Tax",
                "rate": 0.5,
                "amount": 225,
                "tax_class": {
                  "code": "US",
                  "class_id": "0",
                  "name": "Brutal Tax"
                },
                "id": "Brutal Tax"
              }
            ]
          },
          "type": "item",
          "wrapping": {
            "id": "d2675662-6326-4a23-9107-ab71fa6a21a1",
            "price": {
              "amount_inclusive": 7.5,
              "amount_exclusive": 5,
              "total_tax": 2.5,
              "tax_rate": 0.5,
              "sales_tax_summary": [
                {
                  "name": "BRUTAL TAX",
                  "rate": 0.5,
                  "amount": 2.5,
                  "tax_class": {
                    "code": "US",
                    "class_id": "6",
                    "name": "Wrapping"
                  },
                  "id": "1"
                }
              ]
            },
            "type": "wrapping"
          }
        },
        {
          "id": "d2675662-6326-4a23-9107-ab71fa6a21a1",
          "price": {
            "amount_inclusive": 300,
            "amount_exclusive": 200,
            "total_tax": 100,
            "tax_rate": 0.5,
            "sales_tax_summary": [
              {
                "name": "Brutal Tax",
                "rate": 0.5,
                "amount": 100,
                "tax_class": {
                  "code": "US",
                  "class_id": "0",
                  "name": "Brutal Tax"
                },
                "id": "Brutal Tax"
              }
            ]
          },
          "type": "item",
          "wrapping": {
            "id": "d2675662-6326-4a23-9107-ab71fa6a21a1",
            "price": {
              "amount_inclusive": 7.5,
              "amount_exclusive": 5,
              "total_tax": 2.5,
              "tax_rate": 0.5,
              "sales_tax_summary": [
                {
                  "name": "BRUTAL TAX",
                  "rate": 0.5,
                  "amount": 2.5,
                  "tax_class": {
                    "code": "US",
                    "class_id": "6",
                    "name": "Wrapping"
                  },
                  "id": "1"
                }
              ]
            },
            "type": "wrapping"
          }
        }
      ],
      "shipping": {
        "id": "5d522b889d3d9",
        "price": {
          "amount_inclusive": 15,
          "amount_exclusive": 10,
          "total_tax": 5,
          "tax_rate": 0.5,
          "sales_tax_summary": [
            {
              "name": "Brutal Tax",
              "rate": 0.5,
              "amount": 5,
              "tax_class": {
                "code": "US",
                "class_id": "0",
                "name": "Brutal Tax"
              },
              "id": "Brutal Tax"
            }
          ]
        },
        "type": "shipping"
      },
      "handling": {
        "id": "5d522b889d3d9",
        "price": {
          "amount_inclusive": 0,
          "amount_exclusive": 0,
          "total_tax": 0,
          "tax_rate": 0.5,
          "sales_tax_summary": [
            {
              "name": "Brutal Tax",
              "rate": 0.5,
              "amount": 0,
              "tax_class": {
                "code": "US",
                "class_id": "0",
                "name": "Brutal Tax"
              },
              "id": "Brutal Tax"
            }
          ]
        },
        "type": "handling"
      }
    }
  ]
}

Replace the persisted tax quote (identified by the given unique ID) with the provided quote request (represented by the AdjustRequest).

Relevant for returns, partial refunds, and other Order modifications where there have been changes to the tax liabilities.

The returned Tax Quote response is expected to be the same to a response returned by an equivalent response to estimate or commit methods.

Server URL

For supporting tax providers, the server URL contains the tax providerʼs profile field; for example, your_profile.example.com.

The Try it feature is not currently supported for this endpoint.

Replace the persisted tax quote (identified by the given unique ID) with the provided quote request (represented by the **AdjustRequest**). Relevant for returns, partial refunds, and other Order modifications where there have been changes to the tax liabilities. The returned **Tax Quote** response is expected to be the same to a response returned by an equivalent response to **estimate** or **commit** methods. > Server URL > - For supporting tax providers, the server URL contains the tax providerʼs profile field; for example, `your_profile.example.com`. > - The Try it feature is not currently supported for this endpoint.

Authentication

AuthorizationBasic

The HTTP Basic Authentication (developer.mozilla.org) credentials used to authenticate each API request to the tax provider from the associated store; set and update username, password, and optionally profile, using the Update a Connection request. profile is an optional field and will be used with supporting providers only.

For more, see developer-configured authentication for Provider APIs.

The [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) (developer.mozilla.org) credentials used to authenticate each API request to the tax provider from the associated store; set and update `username`, `password`, and optionally `profile`, using the [Update a Connection](/developer/api-reference/rest/tax-provider/tax-provider-connection#update-a-connection) request. `profile` is an optional field and will be used with supporting providers only. For more, see [developer-configured authentication](/developer/docs/overview/api-accounts#developer-configured-authentication) for Provider APIs.

Query parameters

idstringRequired

Unique ID identifying the existing, persisted tax quote that will be adjusted.

Request

This endpoint expects an object.

currency_codestringRequired

ISO 4217 3 character currency code that all prices on this request are in.

customerobjectRequired

If the shopper is a registered customer in the merchant’s store, basic details for that customer.

documentslist of objectsRequired

One or more consignments containing items being purchased by the shopper, including shipping and handling fees that are charged for each consignment. Most orders will contain a single consignment (to a single shipping address), however the BigCommerce platform also supports “Multi-address orders” which allow shoppers to place a single order with items shipped to different addresses.

idstringRequired

Unique ID of the taxable document (order, cart, quote, etc) this tax quote request is being generated for. Will remain consistent for the lifetime of the entity being estimated.

transaction_datedatetimeRequired

ISO 8601 formatted date the shopper placed this order. Tax quotes are expected to reflect taxes applicable on this date. Dates will be provided in UTC.

adjust_descriptionstringOptional

Specifies the reason for the adjustment operation, for auditing purposes. May be a custom, user-entered description.

Response

Returned Tax Quote response matches the updated QuoteRequest provided to the service method.

idstring

The unique identifier of the tax quote that was requested. This value must either match the ID of the requested quote or be an external ID on the tax provider’s system. This value will be used for future adjust and void operations.

documentslist of objects

Represents an order quote or part of an order quote of tax-relevant items fulfilled from a single origin address to a single destination address, including arrays of shipping and handling fee objects for each item. Most order quotes contain a single document; however, BigCommerce supports “multi-address orders”, which may come from or go to distinct sets of addresses and thus require multiple documents per quote.

Represents an order quote or part of an order quote of tax-relevant items fulfilled from a single origin address to a single destination address, including arrays of shipping and handling fee objects for each item. Most order quotes contain a single document; however, BigCommerce supports "multi-address orders", which may come from or go to distinct sets of addresses and thus require multiple documents per quote.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

Authentication

Headers

Query parameters

Request

Response

Errors