Start a full catalog sync
- Path
/products/sync- Auth
- Secret key · server only
const url = 'https://releva.ai/api/v0/products/sync';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://releva.ai/api/v0/products/sync \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{}'Queues a full sync of the domain’s catalog from its configured product sync URL, using the domain’s
sync type (api, fbCsvFeed or fbXmlFeed). The request body is ignored. If a sync for the domain is
already queued or running, the call has no further effect. After a successful pass, products that were
not part of it are deleted about two minutes later.
Authorizations
Section titled “Authorizations”Request Body
Section titled “Request Body”The body is ignored. Send {} or no body.
object
Example generated
{}Responses
Section titled “Responses”Accepted for asynchronous processing.
object
Example
{}Authorization header missing, malformed, not a UUID, or unknown.
object
Human-readable error. Several validation errors are joined with a space.
Examples
{ "message": "Authorization header is missing."}{ "message": "Authorization header is malformed. It should look like `Bearer <string>`."}{ "message": "Authorization header contains an invalid Bearer token."}{ "message": "Domain with the provided secret key cannot be found."}The domain is disabled.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "Domain is disabled. Please reach out to support@releva.ai to enable it."}Unexpected server error.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "An internal error occurred."}