Update Store Settings

Update the settings of the store.

🔑Scopes

gift_cards.read_write - Gift Cards Read & Write

Request

Header Params

Accept-Language

enum<string>

optional

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

Allowed values:

enar

Example:

Authorization

string

required

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

X-Manager-Token

string

required

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=

Body Params application/json

is_buy_as_a_guest_enabled

boolean

optional

Determines if the Guest Checkout feature is enabled, allowing users to complete a purchase withouth signing in to the store.

Example:

true

is_gift_order_enabled

boolean

optional

Determines whether gift orders are enabled for the store.

Example:

true

is_gift_order_card_sender_custom_message_enabled

boolean

optional

Determines whether custom messages from the sender are enabled on gift cards.

Example:

true

is_gift_order_customer_motivation_enabled

boolean

optional

Determines whether customer motivation is enabled for gift orders.

Example:

true

is_gift_order_card_sender_custom_media_link_enabled

boolean

optional

Determines whether media links from the sender are enabled on gift cards.

Example:

true

is_gift_order_card_custom_template_enabled

boolean

optional

Determines whether custom templates are enabled for gift cards.

Example:

true

gift_order_card_custom_template_design

array [object {2}]

optional

name

string

optional

The name of the custom design template.

Example:

Spring Theme

file

string

optional

The file link of the custom design template.

Example:

https://media.zid.store/7b2e8360-a350-4344-a833-ae2b698a4c60/751a4de4-4ad2-445e-8200-ac7f2c4dc8ca.jpg

gift_order_message_when_ready

string

optional

The custom message displayed when the gift order is ready.

Example:

Your gift order is ready for pickup!

gift_order_message_when_completed

string

optional

The custom message displayed when the gift order is completed.

Example:

Thank you for your gift order!

Example

{
  "is_buy_as_a_guest_enabled": true,
  "is_gift_order_enabled": true,
  "is_gift_order_card_sender_custom_message_enabled": true,
  "is_gift_order_customer_motivation_enabled": true,
  "is_gift_order_card_sender_custom_media_link_enabled": true,
  "is_gift_order_card_custom_template_enabled": true,
  "gift_order_card_custom_template_design": [
    {
      "name": "Spring Theme",
      "file": "https://media.zid.store/7b2e8360-a350-4344-a833-ae2b698a4c60/751a4de4-4ad2-445e-8200-ac7f2c4dc8ca.jpg"
    }
  ],
  "gift_order_message_when_ready": "Your gift order is ready for pickup!",
  "gift_order_message_when_completed": "Thank you for your gift order!"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zid.sa/v1/managers/store/settings' \
--header 'Accept-Language;' \
--header 'Authorization: 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' \
--header 'X-Manager-Token: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "is_buy_as_a_guest_enabled": true,
    "is_gift_order_enabled": true,
    "is_gift_order_card_sender_custom_message_enabled": true,
    "is_gift_order_customer_motivation_enabled": true,
    "is_gift_order_card_sender_custom_media_link_enabled": true,
    "is_gift_order_card_custom_template_enabled": true,
    "gift_order_card_custom_template_design": [
        {
            "name": "Spring Theme",
            "file": "https://media.zid.store/7b2e8360-a350-4344-a833-ae2b698a4c60/751a4de4-4ad2-445e-8200-ac7f2c4dc8ca.jpg"
        }
    ],
    "gift_order_message_when_ready": "Your gift order is ready for pickup!",
    "gift_order_message_when_completed": "Thank you for your gift order!"
}'

Responses

🟢200Settings updated successfully.

application/json

Body

is_buy_as_a_guest_enabled

boolean

optional

Determines if the Guest Checkout feature is enabled, allowing users to complete a purchase withouth signing in to the store.

Example:

true

is_gift_order_enabled

boolean

optional

Determines whether gift orders are enabled for the store.

Example:

true

is_gift_order_card_sender_custom_message_enabled

boolean

optional

Determines whether custom messages from the sender are enabled on gift cards.

Example:

true

is_gift_order_customer_motivation_enabled

boolean

optional

Determines whether customer motivation is enabled for gift orders.

Example:

true

is_gift_order_card_sender_custom_media_link_enabled

boolean

optional

Determines whether media links from the sender are enabled on gift cards.

Example:

true

is_gift_order_card_custom_template_enabled

boolean

optional

Determines whether custom templates are enabled for gift cards.

Example:

true

gift_order_card_custom_template_design

array [object {2}]

optional

name

string

optional

The name of the custom design template.

Example:

Spring Theme

file

string

optional

The file link of the custom design template.

Example:

https://media.zid.store/7b2e8360-a350-4344-a833-ae2b698a4c60/751a4de4-4ad2-445e-8200-ac7f2c4dc8ca.jpg

gift_order_message_when_ready

string

optional

The custom message displayed when the gift order is ready.

Example:

Your gift order is ready for pickup!

gift_order_message_when_completed

string

optional

The custom message displayed when the gift order is completed.

Example:

Thank you for your gift order!

Example

{
  "is_buy_as_a_guest_enabled": true,
  "is_gift_order_enabled": true,
  "is_gift_order_card_sender_custom_message_enabled": true,
  "is_gift_order_customer_motivation_enabled": true,
  "is_gift_order_card_sender_custom_media_link_enabled": true,
  "is_gift_order_card_custom_template_enabled": true,
  "gift_order_card_custom_template_design": [
    {
      "name": "Spring Theme",
      "file": "https://media.zid.store/7b2e8360-a350-4344-a833-ae2b698a4c60/751a4de4-4ad2-445e-8200-ac7f2c4dc8ca.jpg"
    }
  ],
  "gift_order_message_when_ready": "Your gift order is ready for pickup!",
  "gift_order_message_when_completed": "Thank you for your gift order!"
}