301RedirectRead

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bigcommerce/main/json-schema/bigcommerce-301-redirect-read-schema.json",
  "title": "301RedirectRead",
  "description": "Full detail of a Redirect, optionally including the full destination URL.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bigcommerce-redirects-api-openapi.yml#/components/schemas/301RedirectRead",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "site_id": {
      "type": "integer"
    },
    "from_path": {
      "type": "string"
    },
    "to": {
      "$ref": "#/$defs/RedirectTo"
    },
    "to_url": {
      "type": "string",
      "description": "Full destination URL for the redirect. Must be explicitly included via URL parameter.",
      "format": "uri"
    }
  },
  "$defs": {
    "RedirectTo": {
      "title": "RedirectTo",
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "product",
            "brand",
            "category",
            "page",
            "post",
            "url"
          ]
        },
        "entity_id": {
          "type": "integer"
        },
        "url": {
          "maxLength": 2048,
          "type": "string"
        }
      }
    }
  }
}