BigCommerce · Schema

Connection Status

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
data object
View JSON Schema on GitHub

JSON Schema

bigcommerce-response-connection-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/response-connection",
  "title": "Connection Status",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string",
          "description": "Identifies a unique account on the external tax provider infrastructure. May be used to reconcile the two platforms."
        },
        "configured": {
          "type": "boolean",
          "description": "Describes whether the stored credentials are considered complete and configured, ready to be used for Tax Provider API requests.\n\nMerchants may enable any **configured** tax provider for storefront tax quotation."
        }
      }
    }
  },
  "x-internal": false
}