Query Catalog Interface Fields
Field | Type | Description |
id | numeric string | ID of a catalog. |
business | string | Business that owns a catalog |
catalog_store | string | The main page of the store associated with the store product catalog |
commerce_merchant_settings | string | Merchant settings for the items sold in a catalog. |
da_display_settings | string | Image display settings such as background cropping and padding of items in the catalog for different Dynamic Ad formats |
default_image_url | string | The URL for the default image, which is used for products without images, or when the product image is temporarily unavailable. If a product image matches the default image, this should be treated as if the image was not loaded. |
fallback_image_url | list<string> | The URL for the fallback image. This is used as the image for auto-generated dynamic items. |
feed_count | int32 | The total number of feeds used by a catalog. |
is_catalog_segment | bool | Verify that you will create ads based on a catalog or catalog segment before you try to create Dynamic Ads. Call this field and determine value otherwise you may get and error when you try to create Dynamic Ads from catalog segments. |
name | string | The name of a catalog given by the creator. |
product_count | int32 | The total number of products in a catalog. |
store_catalog_settings | string | Catalog settings for a store catalog that promotes physical in-store items. |
vertical | enum | The type of catalog (for example: hotels, commerce, etc) |
Query Product Interface Fields
Field | Type | Description |
id | numeric string | ID |
additional_image_cdn_urls | list<list<KeyValue:string,string>> | additional_image_cdn_urls |
additional_image_urls | list<string> | additional_image_urls |
additional_variant_attributes | list<KeyValue:string,string> | additional_variant_attributes |
age_group | enum {adult, all ages, infant, kids, newborn, teen, toddler} | age_group |
applinks | string | applinks |
availability | enum | availability: in stock, out of stock, preorder, available for order, discontinued, pending, mark_as_sold |
brand | string | brand |
capability_to_review_status | list<KeyValue:enum {SHOPS, US_MARKETPLACE, UNIVERSAL_CHECKOUT, BUSINESS_INBOX_IN_MESSENGER, TEST_CAPABILITY},enum {NO_REVIEW, PENDING, REJECTED, APPROVED, OUTDATED}> | capability_to_review_status |
category | string | category |
category_specific_fields | string | category_specific_fields |
color | string | color |
commerce_insights | string | commerce_insights |
condition | enum | condition: new, refurbished, used, used_like_new, used_good, used_fair, cpo, open_box_new |
currency | string | currency |
custom_data | list<KeyValue:string,string> | custom_data |
custom_label_0 | string | custom_label_0 |
custom_label_1 | string | custom_label_1 |
custom_label_2 | string | custom_label_2 |
custom_label_3 | string | custom_label_3 |
custom_label_4 | string | custom_label_4 |
custom_number_0 | string | custom_number_0 |
custom_number_1 | string | custom_number_1 |
custom_number_2 | string | custom_number_2 |
custom_number_3 | string | custom_number_3 |
custom_number_4 | string | custom_number_4 |
description | description | |
errors | errors list<ProductItemError> | |
expiration_date | string | expiration_date |
fb_product_category | string | fb_product_category |
gender | enum | gender: female, male, unisex |
gtin | string | gtin |
image_cdn_urls | list<KeyValue:string,string> | image_cdn_urls |
image_fetch_status | enum | image_fetch_status: NO_STATUS, DIRECT_UPLOAD, FETCHED, FETCH_FAILED, OUTDATED, PARTIAL_FETCH |
image_url | string | image_url |
images | list<string> | images |
importer_address | importer_address | |
importer_name | string | importer_name |
invalidation_errors | list<ProductItemInvalidationError> | invalidation_errors |
inventory | integer | inventory |
manufacturer_info | string | manufacturer_info |
manufacturer_part_number | string | manufacturer_part_number |
marked_for_product_launch | enum | marked_for_product_launch |
material | string | material |
mobile_link | string | mobile_link |
name | string | name |
ordering_index | int32 | ordering_index |
origin_country | enum | origin_country |
parent_product_id | numeric string | parent_product_id |
pattern | string | pattern |
post_conversion_signal_based_enforcement_appeal_eligibility | bool | post_conversion_signal_based_enforcement_appeal_eligibility |
price | string | price |
product_catalog | product_catalog | |
product_feed | product_feed | |
product_group | product_group | |
product_local_info | product_local_info ProductItemLocalInfo | |
product_type | string | product_type |
quantity_to_sell_on_facebook | integer | quantity_to_sell_on_facebook |
retailer_id | string | retailer_id |
retailer_product_group_id | string | retailer_product_group_id |
review_rejection_reasons | list<enum> | review_rejection_reasons |
review_status | enum | review_status: pending, rejected, approved, outdated |
sale_price | string | sale_price |
sale_price_end_date | string | sale_price_end_date |
sale_price_start_date | string | sale_price_start_date |
shipping_weight_unit | enum | shipping_weight_unit:g, kg, oz, lb |
shipping_weight_value | float | shipping_weight_value |
short_description | string | short_description |
size | string | size |
start_date | string | start_date |
url | string | url |
video_fetch_status | enum | video_fetch_status: NO_STATUS, DIRECT_UPLOAD, FETCHED, FETCH_FAILED, OUTDATED, PARTIAL_FETCH |
visibility | enum | visibility: staging, published |
wa_compliance_category | enum | wa_compliance_category |