Create Script Tag

POST 
/openapi/2022-01/script_tags_new

Request

application/json

Body

Body

srcstringrequired

Script file url, for example: https://www.shoplazza.com/x.js

display_scopestringrequired

Display scope, for example: index

event_typestring
Tag type, for example: myapp
Default value: app

Example

{
  "src": "string",
  "display_scope": "string",
  "event_type": "app"
}

Responses

200

200

application/json

Schema

Schema

script_tag object
idstring
Example: f50950fa-40ec-441f-b98d-e1869050dbf2
display_scopestring
Example: all
event_typestring
Example: app
srcstring
Example: https://shoplazza.com/x.js
created_atstring
Example: 2024-04-29T03:22:50Z
updated_atstring
Example: 2024-04-29T03:22:50Z

Example

{
  "script_tag": {
    "id": "f50950fa-40ec-441f-b98d-e1869050dbf2",
    "display_scope": "all",
    "event_type": "app",
    "src": "https://shoplazza.com/x.js",
    "created_at": "2024-04-29T03:22:50Z",
    "updated_at": "2024-04-29T03:22:50Z"
  }
}

Result

{
  "script_tag": {
    "id": "f50950fa-40ec-441f-b98d-e1869050dbf2",
    "display_scope": "all",
    "event_type": "app",
    "src": "https://shoplazza.com/x.js",
    "created_at": "2024-04-29T03:22:50Z",
    "updated_at": "2024-04-29T03:22:50Z"
  }
}

422

422

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "display_scope can't contain [all|checkout|thank_you]"
  ]
}

Result

{
  "errors": [
    "display_scope can't contain [all|checkout|thank_you]"
  ]
}