Create Provider Product Sync Job

Starts a background sync of an external provider's product catalog into the application's provider products. The job is created in the pending state and the call returns straight away with 202. Poll Retrieve Provider Product Sync Job for its progress, and use List Provider Products once it completes.

This needs a privileged LiveLike staff account. A producer access token is not enough, because a catalog sync affects raw provider data that underlies every application.

A job moves through pending, running and then completed or failed. products_synced counts the provider products created or updated by the run, and error_message is set if it failed.

post/{client_id}/provider-product-sync-jobs/

Request

  • Base URL
    https://cf-blast.livelikecdn.com/api/v1/applications
  • URL
    https://cf-blast.livelikecdn.com/api/v1/applications/{client_id}/provider-product-sync-jobs/
  • Auth
    API key in header Authorization

Path parameters

client_idstring required

The client ID of the application.

Request body

providerstring

The provider whose catalog to sync. Defaults to konekt, which is the only provider integrated so far.

Response

Accepted. The sync job was queued.

idstring uuid
providerstring
statusstring
products_syncedinteger

Changes

No recorded changes to this operation across all 1 revision of this API.