- Product card rendering
- JavaScript UI Reference
- Placeholder components
- Customize PLP Styling with SCSS
- Transforming and enriching display data
- Debugging and Error reporting
- Browser compatibility
- Customising price formatting
- Introduction to Depict Performance Client
- Getting started with Depict Performance Client
- Example usage with Next.js
- Search API Overview
- Product listing pages
- Query Suggestions
- Endpoints
- Listing (v3)
- Search (v3)
- Recommendations (v3)
- Other (v3)
- Listing (v2)
- Search (v2)
- Recommendations (v2)
- Events (v2)
- Catalog Push API (v0)
Shopify app
Product Listing Pages and Search
Tracking Product Interactions
HTTP API
Catalog Push API (v0)
Upsert Products
POST
/
catalog
/
v0
/
products
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
UpsertProductsRequest · object
*
merchant
Merchant · string
*
merchant
Required
string
products
Products · array
*
products
Required
array
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
merchant
string
requiredproducts
object[]
requiredproducts.main_product_id
string
requiredproducts.item_group_id
string
requiredproducts.variants
object[]
requiredproducts.variants.product_id
string
requiredproducts.variants.image_urls
string[]
requiredproducts.variants.category_ids
string[]
requiredproducts.variants.brand
string | null
products.variants.inactive
boolean
default: falseproducts.variants.videos
object[] | null
products.variants.videos.video_urls
string[]
requiredproducts.variants.videos.preview_image_url
string | null
requiredproducts.variants.transaction_product_id
string
requiredThe id by which this product is known in the order data in Google Analytics. Merchants should use the same id for the DPC purchase events.
products.variants.locale_attributes
object[]
requiredproducts.variants.locale_attributes.locale_id
string
requiredproducts.variants.locale_attributes.title
string
requiredproducts.variants.locale_attributes.description
string | null
products.variants.locale_attributes.color_name
string | null
products.variants.locale_attributes.size_name
string | null
products.variants.locale_attributes.material
string[] | null
products.variants.locale_attributes.custom_attributes
object
products.variants.inventory_attributes
object[]
requiredproducts.variants.inventory_attributes.inventory_id
string
requiredproducts.variants.inventory_attributes.in_stock
boolean
requiredproducts.variants.inventory_attributes.quantity
integer | null
products.variants.inventory_attributes.custom_attributes
object
products.variants.pricelist_attributes
object[]
requiredproducts.variants.pricelist_attributes.pricelist_id
string
requiredproducts.variants.pricelist_attributes.sale_price
required
products.variants.pricelist_attributes.original_price
required
products.variants.pricelist_attributes.currency
string
requiredproducts.variants.pricelist_attributes.custom_attributes
object
products.variants.gender
enum<string> | null
Available options:
unisex
, men
, women
products.variants.age
enum<string> | null
Available options:
baby
, kid
, teen
, adult
products.variants.size
string | null
products.variants.is_second_hand
boolean | null
products.variants.color_hex
string | null
products.variants.custom_attributes
object
Response
200 - application/json
The response is of type any
.
Was this page helpful?