get https://{shopdomain}.myshoplaza.com/openapi/2022-01/script_tags_new
Requires
read_script_tagsaccess scope.More access scope
The Get Script Tag List API retrieves a paginated list of all script tags in a shop's storefront. This API allows developers to view and manage all script tags applied to their store.
This API is especially useful for:
- Listing all existing script tags.
- Filtering script tags by specific attributes like event type.
- Debugging and reviewing script tag configurations.
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
page | int32 | No | Page number (defaults to 1). | 1 |
limit | int32 | No | Number of records per page (defaults to 50). | 50 |
event_type | string | No | Filter by event type. | myapp |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
script_tags | array of object | ||
script_tags[].id | string | Unique identifier of the script tag. | f50950fa-40ec-441f-b98d-e1869050bdf2 |
script_tags[].display_scope | string | Where the script tag is applied in the storefront. | index |
script_tags[].src | string | URL of the script file. | https://shoplazza.com/x.js |
script_tags[].event_type | string | Tag type, typically used to identify its purpose. | app |
script_tags[].created_at | string | Timestamp indicating when the script tag was created. | 2024-04-29T03:22:50Z |
script_tags[].updated_at | string | Timestamp indicating when the script tag was last updated. | 2024-04-29T03:22:50Z |
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 |
|---|---|---|---|
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 |