Storefront UGC
List posts
Returns approved posts that match the requested filters.
https://api.widget.cevoid.com /v1 /postsAuthorizations
Query parameters
marketstringrequiredMarket identifier used for localized product data.
- Length:
1 to 256 - Example:
mar_sweden
profile_idstringReturn posts attributed to this profile.
- Length:
1 to 256 - Example:
prf_jane
label_idstring[]Return posts with these labels. Repeat the parameter to provide more than one label.
- Items:
1 to 50 - Each item: length:
1 to 256 - Example:
["lbl_summer","lbl_featured"]
label_matchenum<string>Match any requested label (default) or require all requested labels. Requires label_id. Unknown labels are ignored for any; all returns no posts if any label is unknown. If no labels resolve, no posts are returned.
- Allowed values:
anyall - Example:
any
gallery_idstringReturn posts selected by this published gallery, newest first. Applies gallery filters but not pinned layout order.
- Length:
1 to 256 - Example:
gal_summer
product_refstringA Cevoid product or variant ID, provider-native ID, SKU, or barcode. Resolves within this workspace and market and selects the product family, including variants and existing tags. Unknown, ambiguous, or more than 100 candidate matches return an empty page; use a Cevoid product ID to disambiguate. Families with more than 1,000 product records return 400 with product_too_broad.
- Length:
1 to 256 - Example:
gid://shopify/Product/123
external_collection_idstringReturn posts containing products in this market-specific external collection.
- Length:
1 to 256 - Example:
summer-sale
cursorstringOpaque cursor returned by the previous page. Keep all other query parameters unchanged.
- Length:
1 to 2048 - Example:
eyJjcmVhdGVkQXQiOiIyMDI2LTA4LTAxVDEwOjAwOjAwLjAwMFoifQ
limitintegerDefault: 20Number of posts to return, from 1 to 50.
- Range:
1 <= x <= 50 - Example:
20
Response
dataobject[]requiredhas_morebooleanrequiredWhether another page is available.
- Example:
true
next_cursorstring | nullrequiredOpaque cursor for the next page, or null when this is the final page.
- Example:
eyJwdWJsaXNoZWRBdCI6IjIwMjYtMDgtMDFUMTA6MDA6MDAuMDAwWiJ9
additional_dataobjectOptional machine-readable error details.
statusintegerrequiredHTTP status code.
- Example:
404
codestringrequiredStable machine-readable error code.
- Example:
not_found
messagestringrequiredHuman-readable error description.
- Example:
Resource not found
request_idstringRequest identifier for support and tracing.
- Example:
req_abc123
additional_dataobjectOptional machine-readable error details.
statusintegerrequiredHTTP status code.
- Example:
404
codestringrequiredStable machine-readable error code.
- Example:
not_found
messagestringrequiredHuman-readable error description.
- Example:
Resource not found
request_idstringRequest identifier for support and tracing.
- Example:
req_abc123
additional_dataobjectOptional machine-readable error details.
statusintegerrequiredHTTP status code.
- Example:
404
codestringrequiredStable machine-readable error code.
- Example:
not_found
messagestringrequiredHuman-readable error description.
- Example:
Resource not found
request_idstringRequest identifier for support and tracing.
- Example:
req_abc123
additional_dataobjectOptional machine-readable error details.
statusintegerrequiredHTTP status code.
- Example:
404
codestringrequiredStable machine-readable error code.
- Example:
not_found
messagestringrequiredHuman-readable error description.
- Example:
Resource not found
request_idstringRequest identifier for support and tracing.
- Example:
req_abc123
additional_dataobjectOptional machine-readable error details.
statusintegerrequiredHTTP status code.
- Example:
404
codestringrequiredStable machine-readable error code.
- Example:
not_found
messagestringrequiredHuman-readable error description.
- Example:
Resource not found
request_idstringRequest identifier for support and tracing.
- Example:
req_abc123
additional_dataobjectrequiredMachine-readable rate-limit details.
statusintegerrequiredHTTP status code.
- Example:
404
codestringrequiredStable machine-readable error code.
- Example:
not_found
messagestringrequiredHuman-readable error description.
- Example:
Resource not found
request_idstringRequest identifier for support and tracing.
- Example:
req_abc123
additional_dataobjectOptional machine-readable error details.
statusintegerrequiredHTTP status code.
- Example:
404
codestringrequiredStable machine-readable error code.
- Example:
not_found
messagestringrequiredHuman-readable error description.
- Example:
Resource not found
request_idstringRequest identifier for support and tracing.
- Example:
req_abc123
additional_dataobjectOptional machine-readable error details.
statusintegerrequiredHTTP status code.
- Example:
404
codestringrequiredStable machine-readable error code.
- Example:
not_found
messagestringrequiredHuman-readable error description.
- Example:
Resource not found
request_idstringRequest identifier for support and tracing.
- Example:
req_abc123