get https://{shopdomain}.myshoplaza.com/openapi/2022-01/products/
Requires
read_productaccess scope. For more access scope
The Shop Details API allows developers to fetch comprehensive information about a shop by using its unique domain prefix (shopdomain) and configurable query parameters. This endpoint supports retrieving specific fields based on the user’s request. For example, users can request key shop attributes such as id, name, and email.This API is especially useful for:
-
Retrieving store metadata like name, owner details, and operational settings.
-
Customizing query results by specifying required fields.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
product_id | string | Yes | 9fb9f3c6-2300-42c1-8593-d9008d7cfc09 | The unique identifier for the product. |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Example | Description |
|---|---|---|---|
product.id |
string |
"9fb9f3c6-2300-42c1-8593-d9008d7cfc09" |
Unique identifier for the product. |
product.title |
string |
"Stylish Shirt" |
Title of the product. |
product.brief |
string |
"A stylish shirt." |
Brief description or summary of the product. |
product. |
string |
"" |
Full description of the product. |
product. |
boolean |
true |
Indicates whether the product is published. |
product. |
boolean |
true |
Indicates if the product requires shipping. |
product. |
boolean |
true |
Indicates if the product is subject to tax. |
product.tags |
string |
"shirt,stylish,cotton" |
Tags associated with the product, separated by commas. |
product.vendor |
string |
"Awesome Vendor" |
Name of the product vendor. |
product.vendor_url |
string |
"https://awesomevendor.com" |
URL of the vendor's website. |
product. |
integer |
300 |
Total inventory available for the product. |
product. |
string (ISO8601) |
"2024-12-03T19:02:30Z" |
Timestamp when the product was published. |
product. |
string (ISO8601) |
"2024-12-03T19:02:30Z" |
Timestamp when the product was created. |
product. |
string (ISO8601) |
"2024-12-03T19:02:30Z" |
Timestamp when the product was last updated. |
product.note |
string |
"Special promotion item." |
Notes or special remarks about the product. |
product. |
string |
"Buy Stylish Shirt Online" |
SEO-friendly title for the product. |
product. |
string |
"Premium cotton" |
SEO-friendly description for the product. |
product. |
string |
"shirt, cotton, stylish" |
SEO keywords for the product, separated by commas. |
product.handle |
string |
"stylish-shirt-zbxf" |
URL-friendly handle for the product. |
product. |
boolean |
false |
Indicates if the product has only the default variant. |
product. |
string |
"//img.fantaskycdn.com/loading.png" |
Source URL of the product's main image. |
product. |
integer |
100 |
Width of the product's main image in pixels. |
product. |
integer |
100 |
Height of the product's main image in pixels. |
product. |
string |
"loading.png" |
File path of the product's main image. |
product. |
string |
"" |
Alternative text for the product's main image. |
product.images |
array of image object | See images fields below |
Array of additional images for the product. |
product.images[].id |
string |
"15333433-a0d5-44c9-941b-2c59ea07683e" |
Unique identifier for the image. |
product.images[]. |
string |
"9fb9f3c6-2300-42c1-8593-d9008d7cfc09" |
ID of the product associated with the image. |
product.images[]. |
integer |
1 |
Position of the image in the gallery. |
product.images[]. |
string |
"//img.fantaskycdn.com/loading.png" |
Source URL of the image. |
product. |
string |
"d7c7f9ba-f824-46b6-94af-1c2d1befaf27" |
Unique identifier for the variant. |
product. |
string |
"Small-Red" |
Title of the variant. |
product. |
string |
"Small" |
Value of the first option for the variant. |
product. |
string |
"Red" |
Value of the second option for the variant. |
product. |
string |
"19.99" |
Price of the variant. |
product. |
string |
"SS1234-RD-S" |
Stock Keeping Unit (SKU) for the variant. |
product. |
integer |
100 |
Inventory quantity for the variant. |
product. |
array of wholesale price | See wholesale_price fields below |
Wholesale price information for the variant. |
product. |
string |
"19.99" |
Wholesale price for the variant. |
product.variants[]. |
integer |
1 |
Minimum quantity for the wholesale price. | product.category |
Object |
Category object | Category information for the product. |
product.category.id |
integer |
368313940138040900 | The ID of the category. |
product. |
string |
"3" | Category name. |
product. |
integer |
0 | Google category ID. |
product. |
integer |
"3" | Level of category. |
product. |
string |
"368313940138008142, 368313940138024526, 368313940138040910" |
The full path of a category, consisting of category IDs. |
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 |
|---|---|---|---|
errors | Array | ["Context"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | Array | "store is not active" | Indicates an error encountered during the process. |
Error Details
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 422 | productId has an invalid UUID | The product_id provided is invalid. | {"errors": ["productId has an invalid UUID"]} |