Query URL routing

Requires read_url_route access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/url-structure/setting.json

[]

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

[]

Query URL routing structure

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

dataobject
[]
URL structure configuration
blog_custom_url string
[]
URL rules for blog Note: If the URL structure setting is not "custom", NULL is returned
[]
Example: /blogs/%blog-handle%/%article-handle%
blog_url_type string
[]
The URL type of the blog. Valid enumeration values include: ● SHORT: short link, the link carries the resource identifier. ● LONG: long link, the link carries the "resource type" and the resource identifier ● CUSTOM: allows full customization of the link of this resource
[]
Example: LONG
collection_custom_url string
[]
URL rules for product categories. Note: If the URL structure setting is not "custom", NULL is returned.
[]
Example: /collections/%collection-handle%
collection_url_type string
[]
The URL type of the product categories. Valid enumeration values include: ● SHORT: short link, the link carries the resource identifier. ● LONG: long link, the link carries the "resource type" and the resource identifier ● CUSTOM: allows full customization of the link of this resource
[]
Example: LONG
enable boolean
[]
Whether the URL structure setting of the store is enabled. Valid enumeration values include: ● true: URL structure setting is enabled ● false: URL structure setting is disabled Note: For an introduction to the custom URL function, please refer to: https://help.shopline.com/hc/articles/33749590631961
[]
Example: true
page_custom_url string
[]
URL rules for custom page Note: If the URL structure setting is not "custom", NULL is returned
[]
Example: /pages/%page-handle%
page_url_type string
[]
The URL type of the custom page. Valid enumeration values include: ● SHORT: short link, the link carries the resource identifier. ● LONG: long link, the link carries the "resource type" and the resource identifier Note: Custom pages do not support the CUSTOM type.
[]
Example: LONG
product_custom_url string
[]
URL rules for custom product Note: If the URL structure setting is not "custom", NULL is returned
[]
Example: /products/%product-handle%
product_url_type string
[]
The URL type of the product. Valid enumeration values include: ● SHORT: short link, the link carries the resource identifier. ● LONG: long link, the link carries the "resource type" and the resource identifier ● CUSTOM: allows full customization of the link of this resource
[]
Example: LONG

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/url-structure/setting.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal