For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
          • MUTcreateAppExtension
          • MUTupdateAppExtension
          • MUTdeleteAppExtension
          • MUTcreateChannel
          • MUTremoveProductBasicInformationOverrides
          • MUTremoveProductSeoInformationOverrides
          • MUTremoveProductOptionsOverrides
          • MUTremoveProductStorefrontDetailsOverrides
          • MUTremoveProductPreOrderSettingsOverrides
          • MUTsetProductBasicInformation
          • MUTsetProductIsFeatured
          • MUTremoveProductIsFeaturedOverride
          • MUTsetProductSeoInformation
          • MUTsetProductStorefrontDetails
          • MUTsetProductPreOrderSettings
          • MUTsetProductOptionsInformation
          • MUTsetProductUrlPath
          • MUTremoveProductUrlPathOverride
          • MUTsetProductModifiersInformation
          • MUTremoveProductModifiersOverrides
          • MUTremoveProductCustomFieldsOverrides
          • MUTupdateProductCustomFields
          • MUTaddImagesToProduct
          • MUTremoveImagesFromProduct
          • MUTupdateProductImageProperties
          • MUTremoveProductImagePropertiesOverrides
          • MUTsetSharedProductModifiersInformation
          • MUTremoveSharedProductModifiersOverrides
          • MUTsetSharedProductOptionsInformation
          • MUTremoveSharedProductOptionsOverrides
          • MUTsettings
          • MUTupdateTranslations
          • MUTdeleteTranslations
          • MUTaddLocale
          • MUTdeleteLocale
          • MUTupdateLocale
          • MUTcreateEventBridgeWebhook
          • MUTcreatePubSubWebhook
          • MUTupdatePubSubWebhook
          • MUTupdateEventBridgeWebhook
          • MUTcreateHttpsWebhook
          • MUTdeleteWebhook
          • MUTupdateHttpsWebhook
          • MUTcreateMetafield
          • MUTupdateMetafield
          • MUTdeleteMetafield
          • MUTreassignMetafieldsOwner
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLAdminMutations

setProductUrlPath

Example Query
1mutation ExampleMutation($input: SetProductUrlPathInput) {
2  setProductUrlPath(input: $input) {
3    product {
4      id
5      basicInformation
6      isFeatured
7      urlPath
8      overridesForLocale
9      overridesForChannel
10      seoInformation
11      storefrontDetails
12      preOrderSettings
13      customFields
14    }
15    errors
16  }
17}
Variables
1{
2  "input": {
3    "localeContext": {
4      "channelId": "example",
5      "locale": "example"
6    },
7    "data": {
8      "path": "example"
9    },
10    "productId": "example"
11  }
12}
Example response
1{
2  "data": {
3    "setProductUrlPath": {
4      "product": {
5        "id": "example",
6        "basicInformation": {
7          "description": null,
8          "name": null
9        },
10        "isFeatured": true,
11        "urlPath": {
12          "path": null
13        },
14        "overridesForLocale": {
15          "basicInformation": null,
16          "seoInformation": null,
17          "storefrontDetails": null,
18          "urlPath": null,
19          "preOrderSettings": null
20        },
21        "overridesForChannel": {
22          "isFeatured": null
23        },
24        "seoInformation": {
25          "metaDescription": null,
26          "pageTitle": null
27        },
28        "storefrontDetails": {
29          "warranty": null,
30          "availabilityDescription": null,
31          "searchKeywords": null
32        },
33        "preOrderSettings": {
34          "message": null
35        },
36        "customFields": {
37          "pageInfo": null,
38          "edges": null
39        }
40      },
41      "errors": [
42        {
43          "message": "example"
44        }
45      ]
46    }
47  }
48}
Sets a product URL path.
Was this page helpful?
Previous

setProductOptionsInformation

Next

removeProductUrlPathOverride

Built with

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.