AppsThemesAPIs and referencesChangelogSupportFeedBack
API Reference
Log inSign up

Update Shop

patch https://{shopdomain}.myshoplaza.com/openapi/2022-01/shop/

🔒

Requires write_shop access scope. For more access scope

The Update Shop API updates shop-related information, such as the customer email. It ensures secure and validated updates to a shop's data.

This API is especially useful for:

  1. Updating customer-related shop details.
  2. Managing shop information programmatically.

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Path Request Parameters

FieldTypeRequiredDescriptionExample
shop_idstringNoshop's ID123232

Body Request Parameters

FieldTypeRequiredDescriptionExample
customer_emailstringNoEmail of the customer associated with the shop.example@shop.com

Response Explanation

Public Response Parameters

📘

Public Response Parameters

Successful Response

Name Type Example Description
shop.id int 633130 The unique ID of the shop.
shop.name string test-shoplazza The name of the shop.
shop.email string test@shoplazza.com The email of the shop.
shop.domain string test-shoplazza.stg.myshoplaza.com The shop's domain.
shop.address1 string address1 The primary address of the shop.
shop.zip string 515300 The zip code of the shop.
shop.city string city The city of the shop.
shop.phone string 15014471143 The shop's phone number.
shop.primary_locale string en-US The shop's primary locale.
shop.address2 string "" The secondary address of the shop.
shop.created_at string 2023-11-08T11:51:39Z The creation time of the shop.
shop.updated_at string 2024-04-29T09:58:04Z The last update time of the shop.
shop.country_code string CN The country code of the shop.
shop.currency string USD The shop's currency.
shop.customer_email string bcd@shoplazza.com The customer's email for the shop.
shop.timezone string +0800 The timezone of the shop.
shop.shop_owner string test-shoplazza The owner of the shop.
shop.account string test@shoplazza.com The shop's account email.
shop.province_code string CN-GD The province code of the shop.
shop.icon.src string http://img.staticdj.com/55f1a60e47d1462c7d88dec3844369f0.png The source URL of the shop's icon.
shop.icon.path string 55f1a60e47d1462c7d88dec3844369f0.png The file path of the shop's icon.
shop.icon.alt string "" Alternate text for the shop's icon.
shop.system_domain string test-shoplazza.stg.myshoplaza.com The system domain of the shop.
shop.root_url string "" The root URL of the shop.

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.

FieldTypeExampleDescription
errorsArray[ "Collection not found"]A list of errors encountered during the request processing.
FieldTypeExampleDescription
errorString "store is not active"Indicates an error encountered during the process

Error Detail

Status CodeMessagePossible ReasonExample Response
400Bad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).Bad Request
UnauthorizedThe request is missing valid authentication credentials or the credentials provided are invalid.Unauthorized

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!

Support

Shoplazza

Updates

Partner Program

Support

Shoplazza

Updates

Partner Program

Follow Us

© Shoplazza
Partner Program Agreement API Terms Terms of Service Privacy Policy Use Policy