Jump to

• Request
• Response

generateURLSlugMap

put

/ccadmin/v1/urlPatterns/{id}/generate

Generate URL slugs for the URL pattern identified by the ID parameter.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID of the URL pattern

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds. Highlights any duplicates.

Body ()

Root Schema : generateURLSlugMap_response

Type: object

Show Source

• containsDuplicates(optional): boolean
  Default Value: true

  Whether or not there are duplicate URL patterns.
• duplicates(optional): array duplicates
  Duplicate URL slugs.

{
    "properties":{
        "duplicates":{
            "description":"Duplicate URL slugs.",
            "type":"array",
            "items":{
                "properties":{
                    "en":{
                        "description":"Duplicates for specified locale.",
                        "type":"array",
                        "items":{
                            "properties":{
                                "nintendo-switch":{
                                    "description":"Duplicate URL slug for the locale.",
                                    "items":{
                                        "properties":{
                                            "itemDescriptor":{
                                                "default":"product",
                                                "description":"The item descriptor."
                                            },
                                            "displayName":{
                                                "default":"Nintendo Switch",
                                                "description":"Item Display name."
                                            },
                                            "seoUrlSlugDerived":{
                                                "default":"nintendo-switch",
                                                "description":"Item's URL slug."
                                            },
                                            "id":{
                                                "default":"prod130047",
                                                "description":"ID for this item."
                                            }
                                        }
                                    }
                                },
                                "nintendo-switch (duplicate)":{
                                    "description":"Duplicate URL slug for the locale.",
                                    "items":{
                                        "properties":{
                                            "itemDescriptor":{
                                                "default":"category",
                                                "description":"The item descriptor."
                                            },
                                            "displayName":{
                                                "default":"Nintendo Switch games",
                                                "description":"Item Display name."
                                            },
                                            "seoUrlSlugDerived":{
                                                "default":"nintendo-switch",
                                                "description":"Item's URL slug."
                                            },
                                            "id":{
                                                "default":"video-games-123",
                                                "description":"ID for this item."
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "containsDuplicates":{
            "default":true,
            "description":"Whether or not there are duplicate URL patterns.",
            "type":"boolean"
        }
    }
}

Nested Schema : duplicates

Type: array

Duplicate URL slugs.

Show Source

• Array of: object items

{
    "description":"Duplicate URL slugs.",
    "type":"array",
    "items":{
        "properties":{
            "en":{
                "description":"Duplicates for specified locale.",
                "type":"array",
                "items":{
                    "properties":{
                        "nintendo-switch":{
                            "description":"Duplicate URL slug for the locale.",
                            "items":{
                                "properties":{
                                    "itemDescriptor":{
                                        "default":"product",
                                        "description":"The item descriptor."
                                    },
                                    "displayName":{
                                        "default":"Nintendo Switch",
                                        "description":"Item Display name."
                                    },
                                    "seoUrlSlugDerived":{
                                        "default":"nintendo-switch",
                                        "description":"Item's URL slug."
                                    },
                                    "id":{
                                        "default":"prod130047",
                                        "description":"ID for this item."
                                    }
                                }
                            }
                        },
                        "nintendo-switch (duplicate)":{
                            "description":"Duplicate URL slug for the locale.",
                            "items":{
                                "properties":{
                                    "itemDescriptor":{
                                        "default":"category",
                                        "description":"The item descriptor."
                                    },
                                    "displayName":{
                                        "default":"Nintendo Switch games",
                                        "description":"Item Display name."
                                    },
                                    "seoUrlSlugDerived":{
                                        "default":"nintendo-switch",
                                        "description":"Item's URL slug."
                                    },
                                    "id":{
                                        "default":"video-games-123",
                                        "description":"ID for this item."
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• en(optional): array en
  Duplicates for specified locale.

{
    "properties":{
        "en":{
            "description":"Duplicates for specified locale.",
            "type":"array",
            "items":{
                "properties":{
                    "nintendo-switch":{
                        "description":"Duplicate URL slug for the locale.",
                        "items":{
                            "properties":{
                                "itemDescriptor":{
                                    "default":"product",
                                    "description":"The item descriptor."
                                },
                                "displayName":{
                                    "default":"Nintendo Switch",
                                    "description":"Item Display name."
                                },
                                "seoUrlSlugDerived":{
                                    "default":"nintendo-switch",
                                    "description":"Item's URL slug."
                                },
                                "id":{
                                    "default":"prod130047",
                                    "description":"ID for this item."
                                }
                            }
                        }
                    },
                    "nintendo-switch (duplicate)":{
                        "description":"Duplicate URL slug for the locale.",
                        "items":{
                            "properties":{
                                "itemDescriptor":{
                                    "default":"category",
                                    "description":"The item descriptor."
                                },
                                "displayName":{
                                    "default":"Nintendo Switch games",
                                    "description":"Item Display name."
                                },
                                "seoUrlSlugDerived":{
                                    "default":"nintendo-switch",
                                    "description":"Item's URL slug."
                                },
                                "id":{
                                    "default":"video-games-123",
                                    "description":"ID for this item."
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : en

Type: array

Duplicates for specified locale.

Show Source

• Array of: object items

{
    "description":"Duplicates for specified locale.",
    "type":"array",
    "items":{
        "properties":{
            "nintendo-switch":{
                "description":"Duplicate URL slug for the locale.",
                "items":{
                    "properties":{
                        "itemDescriptor":{
                            "default":"product",
                            "description":"The item descriptor."
                        },
                        "displayName":{
                            "default":"Nintendo Switch",
                            "description":"Item Display name."
                        },
                        "seoUrlSlugDerived":{
                            "default":"nintendo-switch",
                            "description":"Item's URL slug."
                        },
                        "id":{
                            "default":"prod130047",
                            "description":"ID for this item."
                        }
                    }
                }
            },
            "nintendo-switch (duplicate)":{
                "description":"Duplicate URL slug for the locale.",
                "items":{
                    "properties":{
                        "itemDescriptor":{
                            "default":"category",
                            "description":"The item descriptor."
                        },
                        "displayName":{
                            "default":"Nintendo Switch games",
                            "description":"Item Display name."
                        },
                        "seoUrlSlugDerived":{
                            "default":"nintendo-switch",
                            "description":"Item's URL slug."
                        },
                        "id":{
                            "default":"video-games-123",
                            "description":"ID for this item."
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• nintendo-switch(optional): array nintendo-switch
  Duplicate URL slug for the locale.
• nintendo-switch (duplicate)(optional): array nintendo-switch (duplicate)
  Duplicate URL slug for the locale.

{
    "properties":{
        "nintendo-switch":{
            "description":"Duplicate URL slug for the locale.",
            "items":{
                "properties":{
                    "itemDescriptor":{
                        "default":"product",
                        "description":"The item descriptor."
                    },
                    "displayName":{
                        "default":"Nintendo Switch",
                        "description":"Item Display name."
                    },
                    "seoUrlSlugDerived":{
                        "default":"nintendo-switch",
                        "description":"Item's URL slug."
                    },
                    "id":{
                        "default":"prod130047",
                        "description":"ID for this item."
                    }
                }
            }
        },
        "nintendo-switch (duplicate)":{
            "description":"Duplicate URL slug for the locale.",
            "items":{
                "properties":{
                    "itemDescriptor":{
                        "default":"category",
                        "description":"The item descriptor."
                    },
                    "displayName":{
                        "default":"Nintendo Switch games",
                        "description":"Item Display name."
                    },
                    "seoUrlSlugDerived":{
                        "default":"nintendo-switch",
                        "description":"Item's URL slug."
                    },
                    "id":{
                        "default":"video-games-123",
                        "description":"ID for this item."
                    }
                }
            }
        }
    }
}

Nested Schema : nintendo-switch

Type: array

Duplicate URL slug for the locale.

Show Source

• Array of: object items

{
    "description":"Duplicate URL slug for the locale.",
    "items":{
        "properties":{
            "itemDescriptor":{
                "default":"product",
                "description":"The item descriptor."
            },
            "displayName":{
                "default":"Nintendo Switch",
                "description":"Item Display name."
            },
            "seoUrlSlugDerived":{
                "default":"nintendo-switch",
                "description":"Item's URL slug."
            },
            "id":{
                "default":"prod130047",
                "description":"ID for this item."
            }
        }
    }
}

Nested Schema : nintendo-switch (duplicate)

Type: array

Duplicate URL slug for the locale.

Show Source

• Array of: object items

{
    "description":"Duplicate URL slug for the locale.",
    "items":{
        "properties":{
            "itemDescriptor":{
                "default":"category",
                "description":"The item descriptor."
            },
            "displayName":{
                "default":"Nintendo Switch games",
                "description":"Item Display name."
            },
            "seoUrlSlugDerived":{
                "default":"nintendo-switch",
                "description":"Item's URL slug."
            },
            "id":{
                "default":"video-games-123",
                "description":"ID for this item."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• displayName(optional):
  Default Value: Nintendo Switch

  Item Display name.
• id(optional):
  Default Value: prod130047

  ID for this item.
• itemDescriptor(optional):
  Default Value: product

  The item descriptor.
• seoUrlSlugDerived(optional):
  Default Value: nintendo-switch

  Item's URL slug.

{
    "properties":{
        "itemDescriptor":{
            "default":"product",
            "description":"The item descriptor."
        },
        "displayName":{
            "default":"Nintendo Switch",
            "description":"Item Display name."
        },
        "seoUrlSlugDerived":{
            "default":"nintendo-switch",
            "description":"Item's URL slug."
        },
        "id":{
            "default":"prod130047",
            "description":"ID for this item."
        }
    }
}

Nested Schema : items

Type: object

Show Source

• displayName(optional):
  Default Value: Nintendo Switch games

  Item Display name.
• id(optional):
  Default Value: video-games-123

  ID for this item.
• itemDescriptor(optional):
  Default Value: category

  The item descriptor.
• seoUrlSlugDerived(optional):
  Default Value: nintendo-switch

  Item's URL slug.

{
    "properties":{
        "itemDescriptor":{
            "default":"category",
            "description":"The item descriptor."
        },
        "displayName":{
            "default":"Nintendo Switch games",
            "description":"Item Display name."
        },
        "seoUrlSlugDerived":{
            "default":"nintendo-switch",
            "description":"Item's URL slug."
        },
        "id":{
            "default":"video-games-123",
            "description":"ID for this item."
        }
    }
}

Example Response (application/json)

{
    "duplicates":{
        "en":{
            "nintendo-switch":{
                "itemDescriptor":"product",
                "displayName":"Nintendo Switch",
                "seoUrlSlugDerived":"nintendo-switch",
                "id":"prod130047"
            },
            "nintendo-switch (duplicate)":{
                "itemDescriptor":"category",
                "displayName":"Nintendo Switch games",
                "seoUrlSlugDerived":"nintendo-switch",
                "id":"video-games-123"
            }
        },
        "containsDuplicates":true
    }
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top