BigCommerce Docs

mutation ExampleMutation($input: SetProductUrlPathInput) {
  setProductUrlPath(input: $input) {
    product {
      id
      basicInformation
      isFeatured
      urlPath
      overridesForLocale
      overridesForChannel
      seoInformation
      storefrontDetails
      preOrderSettings
      customFields
    }
    errors
  }
}

{
  "input": {
    "localeContext": {
      "channelId": "example",
      "locale": "example"
    },
    "data": {
      "path": "example"
    },
    "productId": "example"
  }
}

{
  "data": {
    "setProductUrlPath": {
      "product": {
        "id": "example",
        "basicInformation": {
          "description": null,
          "name": null
        },
        "isFeatured": true,
        "urlPath": {
          "path": null
        },
        "overridesForLocale": {
          "basicInformation": null,
          "seoInformation": null,
          "storefrontDetails": null,
          "urlPath": null,
          "preOrderSettings": null
        },
        "overridesForChannel": {
          "isFeatured": null
        },
        "seoInformation": {
          "metaDescription": null,
          "pageTitle": null
        },
        "storefrontDetails": {
          "warranty": null,
          "availabilityDescription": null,
          "searchKeywords": null
        },
        "preOrderSettings": {
          "message": null
        },
        "customFields": {
          "pageInfo": null,
          "edges": null
        }
      },
      "errors": [
        {
          "message": "example"
        }
      ]
    }
  }
}

Sets a product URL path.

Arguments

inputSetProductUrlPathInputRequired

Returns

an optional SetProductUrlPathResult

errorslist of SetProductUrlPathErrors

List of errors that occurred during the set product url path mutation.

productProduct

The product that had its URL path set.