Start

Path Parameters

merchantId int64 required

The Merchant's id

Responses

Found.

*/*

Schema

Example (from schema)

Schema

created_at date-time

The create date-time.

error_reason string

Possible values: <= 500 characters

Error that caused the synchronization to fail.

has_errors boolean

Whether the sync encountered errors.

id int64

The unique id.

merchant_id int64 required

The parent Merchant id.

modified_at date-time

The last modified date-time.

overall_products_in_kg int64

The overall amount of products available on KG after syncing.

products_created int32

The number of created products

products_deleted int32

The number of deleted products

products_errored int32

The number of errored products

products_skipped int32

The number of skipped products

products_total int32

The total number of processed products, including the skipped and errored.

products_unchanged int32

The number of products that haven't changed and therefore haven't been synced again

products_updated int32

The number of update products

started_at date-time

The started date-time.

stopped_at date-time

The stopped date-time.

synced_products_in_kg int64

The number of products synced by this process available in KG.

synced_products_in_kg_before_cleanup int64

{
  "created_at": "2024-11-19T00:12:35.617Z",
  "error_reason": "string",
  "has_errors": true,
  "id": 0,
  "merchant_id": 0,
  "modified_at": "2024-11-19T00:12:35.617Z",
  "overall_products_in_kg": 0,
  "products_created": 0,
  "products_deleted": 0,
  "products_errored": 0,
  "products_skipped": 0,
  "products_total": 0,
  "products_unchanged": 0,
  "products_updated": 0,
  "started_at": "2024-11-19T00:12:35.617Z",
  "stopped_at": "2024-11-19T00:12:35.617Z",
  "synced_products_in_kg": 0,
  "synced_products_in_kg_before_cleanup": 0
}

Another merchant sync is in already in progress. There can only be one sync running at a time.

application/json

Schema

Example (from schema)

Schema

detail string

instance uri

properties object

property name* object

status int32

title string

type uri

{
  "detail": "string",
  "instance": "string",
  "properties": {},
  "status": 0,
  "title": "string",
  "type": "string"
}

Start​

Start