get https://{shopdomain}.myshoplaza.com/openapi/2022-01/pages/
Requires
read_shop_navigationaccess scope. More access scope
The Get Page Details API retrieves the detailed information of a specific page by its unique ID.
This API is especially useful for:
- Fetching the complete content and metadata of a page for editing or viewing.
- Debugging or auditing page details.
- Automating workflows that require specific page information.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Description | Example | Required |
|---|---|---|---|---|
id | string | The ID of the page. | 15979 | Yes |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Description | Example |
|---|---|---|---|
id | int | Unique ID of the page. | 15979 |
title | string | Title of the page. | "Test" |
content | string | HTML content of the page. | "<p>Welcome to my page!</p>" |
status | int | Status of the page (1 for active). | 1 |
created_at | string | Timestamp of when the page was created. | "1714377813" |
updated_at | string | Timestamp of the last update. | "1714377813" |
url | string | URL of the page. | "/pages/test1" |
meta_title | string | SEO title of the page. | "Test" |
meta_keyword | string | SEO keywords for the page. | "" |
meta_description | string | SEO description of the page. | "Welcome to my page!" |
independent_seo | boolean | Whether SEO is managed independently. | false |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "file number error"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "page not found" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 422 | Unprocessable Entity | Missing the request file | "id params err" |
| 404 | Not Found | can't find the page id. | "page not found" |