Jump to

• Request
• Response

listURLPatterns

get

/ccadmin/v1/urlPatterns

List URL Patterns. Gets the list of URL patterns used to build storefront URLs.

Request

Supported Media Types

• application/json

Query Parameters

• type(optional): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listURLPatterns_response

Type: object

Show Source

• items(optional): array items
  The list of URL pattern objects.

{
    "properties":{
        "items":{
            "description":"The list of URL pattern objects.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "availableProperties":{
                        "description":"Properties available to use in URL Patterns",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "default":{
                        "description":"Default URL Pattern.",
                        "type":"string"
                    },
                    "translations":{
                        "description":"List of translated URL Patterns",
                        "type":"object"
                    },
                    "name":{
                        "description":"Name used in the admin ui.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The repo id",
                        "type":"string"
                    },
                    "autoRedirect":{
                        "description":"Flag on whether to use the auto redirect functionality.",
                        "type":"boolean"
                    },
                    "value":{
                        "description":"The value of currently set URL Pattern.",
                        "type":"string"
                    },
                    "example":{
                        "description":"The example URL built off the default product/category of currently set URL Pattern.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The list of URL pattern objects.

Show Source

• Array of: object items

{
    "description":"The list of URL pattern objects.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "availableProperties":{
                "description":"Properties available to use in URL Patterns",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "default":{
                "description":"Default URL Pattern.",
                "type":"string"
            },
            "translations":{
                "description":"List of translated URL Patterns",
                "type":"object"
            },
            "name":{
                "description":"Name used in the admin ui.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The repo id",
                "type":"string"
            },
            "autoRedirect":{
                "description":"Flag on whether to use the auto redirect functionality.",
                "type":"boolean"
            },
            "value":{
                "description":"The value of currently set URL Pattern.",
                "type":"string"
            },
            "example":{
                "description":"The example URL built off the default product/category of currently set URL Pattern.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• autoRedirect(optional): boolean
  Flag on whether to use the auto redirect functionality.
• availableProperties(optional): array availableProperties
  Properties available to use in URL Patterns
• default(optional): string
  Default URL Pattern.
• example(optional): string
  The example URL built off the default product/category of currently set URL Pattern.
• name(optional): string
  Name used in the admin ui.
• repositoryId(optional): string
  The repo id
• translations(optional): object translations
  List of translated URL Patterns
• value(optional): string
  The value of currently set URL Pattern.

{
    "type":"object",
    "properties":{
        "availableProperties":{
            "description":"Properties available to use in URL Patterns",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "default":{
            "description":"Default URL Pattern.",
            "type":"string"
        },
        "translations":{
            "description":"List of translated URL Patterns",
            "type":"object"
        },
        "name":{
            "description":"Name used in the admin ui.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repo id",
            "type":"string"
        },
        "autoRedirect":{
            "description":"Flag on whether to use the auto redirect functionality.",
            "type":"boolean"
        },
        "value":{
            "description":"The value of currently set URL Pattern.",
            "type":"string"
        },
        "example":{
            "description":"The example URL built off the default product/category of currently set URL Pattern.",
            "type":"string"
        }
    }
}

Nested Schema : availableProperties

Type: array

Properties available to use in URL Patterns

Show Source

• Array of: string

{
    "description":"Properties available to use in URL Patterns",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : translations

Type: object

List of translated URL Patterns

Example Response (application/json)

[
    [
        {
            "availableProperties":[
                "description",
                "displayName",
                "id",
                "parentCategory",
                "seoDescriptionDerived",
                "seoTitleDerived",
                "seoUrlSlugDerived"
            ],
            "default":"/{seoTitleDerived}/category/{id}",
            "translations":{
                "1":"/{seoTitleDerived}/category/{id}"
            },
            "name":"Collection Page",
            "repositoryId":"categoryPageRoute",
            "autoRedirect":true,
            "value":"/{seoTitleDerived}/category/{id}",
            "example":"/cameras-and-camcorders/category/cameracat"
        },
        {
            "availableProperties":[
                "CountryOfOrigin",
                "brand",
                "description",
                "displayName",
                "id",
                "parentCategory",
                "seoDescriptionDerived",
                "seoTitleDerived",
                "seoUrlSlugDerived",
                "type"
            ],
            "default":"/{seoTitleDerived}/product/{id}",
            "translations":{
                "1":"/{seoTitleDerived}/product/{id}"
            },
            "name":"Product Page",
            "repositoryId":"productPageRoute",
            "autoRedirect":true,
            "value":"/{seoTitleDerived}/product/{id}",
            "example":"/samsung-f90bn-hd-flash-memory-camcorder/product/camcorder_1"
        }
    ]
]

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