Create a new script

POSTv1/managers/app-scripts

Utilize this endpoint to create a new script. Investigate the available events here.

Request

Header Params

Accept-Language

enum<string>

optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:

enar

Example:

User-Agent

string

optional

The User-Agent header contains information about the user agent (browser or app) making the request. It allows the server to provide a tailored response depending on the user agent's capabilities and preferences.

Example:

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36

string

optional

Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format.

Example:

application/json

Authorization

string

optional

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

Content-Type

enum<string>

optional

The Media Type of the body of the request. This is used to describe the structure of the data in the body.

Allowed values:

application/jsonmultipart/form-dataapplication/x-www-form-urlencoded

Example:

application/json

X-Manager-Token

string

optional

This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.

Example:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

url

string <uri>

required

The URL of the script file.

Example:

https://raw.githubusercontent.com/gharbat/js-cs/main/test.js

purchase_event

string

optional

JavaScript code to be executed when the Purchase event occurs.

Example:

console.log(transactionItems)

product_details_event

string

optional

JavaScript code to be executed when the Product Details event occurs.

Example:

console.log(productViewd)

add_to_cart_event

string

optional

JavaScript code to be executed when the Add To Cart event occurs.

Example:

console.log(productCart)

remove_from_cart_event

string

optional

JavaScript code to be executed when the Remove From Cart event occurs.

Example:

console.log(productCart)

start_checkout_event

string

optional

JavaScript code to be executed when the Start Checkout event occurs.

Example:

console.log(cart)

{
  "url": "https://raw.githubusercontent.com/gharbat/js-cs/main/test.js",
  "purchase_event": "console.log(transactionItems)",
  "product_details_event": "console.log(productViewd)",
  "add_to_cart_event": "console.log(productCart)",
  "remove_from_cart_event": "console.log(productCart)",
  "start_checkout_event": "console.log(cart)"
}

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

Successfully created the new script

url

string <uri>

required

The URL of the script file.

Example:

https://raw.githubusercontent.com/gharbat/js-cs/main/test.js

purchase_event

string

optional

JavaScript code to be executed when the Purchase event occurs.

Example:

console.log(transactionItems)

product_details_event

string

optional

JavaScript code to be executed when the Product Details event occurs.

Example:

console.log(productViewd)

add_to_cart_event

string

optional

JavaScript code to be executed when the Add To Cart event occurs.

Example:

console.log(productCart)

remove_from_cart_event

string

optional

JavaScript code to be executed when the Remove From Cart event occurs.

Example:

console.log(productCart)

start_checkout_event

string

optional

JavaScript code to be executed when the Start Checkout event occurs.

Example:

console.log(cart)

Not configured

Last modified: 2 months ago