BigCommerce · Schema

customUrl_Full

The custom URL for the product on the storefront.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
url	string	Product URL on the storefront.
is_customized	boolean	Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/customUrl_Full",
  "title": "customUrl_Full",
  "type": "object",
  "properties": {
    "url": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "Product URL on the storefront.\n",
      "x-required": [
        "post",
        "put"
      ],
      "x-url": true
    },
    "is_customized": {
      "type": "boolean",
      "description": "Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).\n",
      "x-required": [
        "post",
        "put"
      ]
    }
  },
  "description": "The custom URL for the product on the storefront.",
  "x-internal": false
}