Primary navigation

Products

Retrieve and upsert products for a feed.

Overview

Use these endpoints to retrieve the current products for a feed or upsert partial product changes matched by id.

REST endpoints

  • GET /product_feeds/{id}/products returns the products for the specified feed.
  • PATCH /product_feeds/{id}/products upserts products into the specified feed. Products are matched by id, and products not included in the request remain unchanged.

GET /product_feeds/{id}/products

Returns the products for the specified feed.

Path parameters

FieldTypeRequiredDescription
idstringYesIdentifier for the feed.

Request

This endpoint does not define a request body.

Response

200 OK

FieldTypeRequiredDescription
target_countrystringNoTwo letter country code per ISO 3166.
productsProduct[]YesArray of products for the specified feed.

404 Not Found

Returned when the feed is not found.

PATCH /product_feeds/{id}/products

Upserts products into the specified feed. Products are matched by id. Products not included in the request remain unchanged.

Path parameters

FieldTypeRequiredDescription
idstringYesIdentifier for the feed.

Request

FieldTypeRequiredDescription
target_countrystringNoTwo letter country code per ISO 3166.
productsProduct[]YesArray of products for the product feed.

Response

200 OK

Returns the following acceptance object:

FieldTypeRequiredDescription
idstringYesIdentifier for the feed.
acceptedbooleanYesWhether the product payload was accepted.

400 Bad Request

Returned when the product payload is invalid.

404 Not Found

Returned when the feed is not found.

Schema reference

Product

FieldTypeRequiredDescription
idstringYesStable global identifier for this product.
titlestringNoProduct title.
descriptionDescriptionNoProduct description content.
urlstring (uri)NoCanonical product URL.
mediaMedia[]NoProduct-level media assets.
variantsVariant[]YesVariants associated with the product.

Variant

FieldTypeRequiredDescription
idstringYesStable global identifier for this variant.
titlestringYesVariant title.
descriptionDescriptionNoVariant description content.
urlstring (uri)NoVariant URL.
barcodesBarcode[]NoVariant barcode values.
pricePriceNoActive sale price for this variant.
list_pricePriceNoReference price before any discount is applied.
unit_priceUnitPriceNoUnit pricing metadata.
availabilityAvailabilityNoAvailability state for the variant.
categoriesCategory[]NoCategories associated with the variant.
conditionConditionNoApplicable item conditions.
variant_optionsVariantOption[]NoSet of option selections for the variant, such as color or size.
mediaMedia[]NoVariant media assets. The first entry is treated as primary.
sellerSellerNoSeller metadata for the variant.

Description

At least one of the following fields must be present.

FieldTypeRequiredDescription
plainstringNoPlain-text description.
htmlstringNoHTML description.
markdownstringNoMarkdown description.

Availability

FieldTypeRequiredDescription
availablebooleanNoIndicates whether the variant is currently purchasable.
statusstringNoFulfillment state when availability is reported, for example in_stock, backorder, preorder, out_of_stock, or discontinued.

Price

FieldTypeRequiredDescription
amountintegerYesMonetary amount expressed in ISO 4217 minor units.
currencystringYesThree-letter ISO 4217 currency identifier.

UnitPrice

FieldTypeRequiredDescription
amountintegerYesUnit price amount.
currencystringYesCurrency code.
measureMeasureYesMeasured quantity.
referenceReferenceMeasureYesReference quantity.

Measure

FieldTypeRequiredDescription
valuenumberYesMeasure value.
unitstringYesMeasure unit.

ReferenceMeasure

FieldTypeRequiredDescription
valueintegerYesReference value.
unitstringYesReference unit.

Barcode

FieldTypeRequiredDescription
typestringYesBarcode type.
valuestringYesBarcode value.

Media

FieldTypeRequiredDescription
typestringYesMedia type.
urlstring (uri)YesMedia URL.
alt_textstringNoAlternate text.
widthintegerNoMedia width.
heightintegerNoMedia height.

VariantOption

FieldTypeRequiredDescription
namestringYesOption name, such as color or size.
valuestringYesSelected option value.

Category

FieldTypeRequiredDescription
valuestringYesCategory label or hierarchical path.
taxonomystringNoTaxonomy system used for the category value, such as google_product_category, shopify, or merchant.

Seller

FieldTypeRequiredDescription
namestringNoSeller name.
linksLink[]NoSeller-related links.
FieldTypeRequiredDescription
typestringYesKind of destination, such as privacy_policy, terms_of_service, refund_policy, shipping_policy, or faq.
titlestringNoLink title.
urlstringYesLink destination URL.

Condition

Condition is an array of strings describing applicable item conditions, such as new or secondhand. More than one value may apply.