Check Connection Options Request Payload

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bigcommerce/main/json-schema/bigcommerce-check-connection-options-request-payload-schema.json",
  "title": "Check Connection Options Request Payload",
  "description": "The payload sent to a Shipping Provider to check that the store is connected to this provider.\n\nEach Shipping Provider will have different configurations for the payload.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bigcommerce-shipping-provider-api-openapi.yml#/components/schemas/CheckConnectionOptionsRequestPayload",
  "type": "object",
  "properties": {
    "connection_options": {
      "$ref": "#/$defs/ConnectionOptionsInstance"
    }
  },
  "required": [
    "connection_options"
  ],
  "x-internal": false,
  "$defs": {
    "ConnectionOptionsInstance": {
      "type": "object",
      "description": "Any global request options declared by the carrier and configured by the merchant to retrieve rates. Optional.",
      "title": "Connection Options Instance",
      "x-internal": false
    }
  }
}