Skip to main content
GET
Get Product Endpoint

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

merchant_id
string
required
main_product_id
string
required

Query Parameters

locale_id
string | null

Response

Successful Response

main_product_id
string
required
title
string
required
description
string
required
color_name
string | null
required
size
string | null
required
main_image_url
required
Required string length: 1 - 2083
hover_image_url
required
Required string length: 1 - 2083
image_urls
string<uri>[]
required
Required string length: 1 - 2083
metadata
(OnSaleMetadata · object | LowStockMetadata · object | OutOfStockMetadata · object | NewInMetadata · object | InactiveMetadata · object | LimitedAvailabilityMetadata · object | BestsellerMetadata · object | TrendingMetadata · object | SlowMoverMetadata · object | StarProductMetadata · object)[]
required
collections
Collection · object[]
required
variants
Variant · object[]
required
inventories
InventoryItem · object[]
required
price_lists
PriceListItem · object[]
required
hidden_in_markets
HiddenVisibilityLocation · object[]