List

List the Merchants Syncs

Path Parameters

merchantId int64 required

The Merchant's id

Query Parameters

cursor string

The cursor

limit integer

Default value: 10

The maximum number of results

sort string

Default value: +id

The sorting, +id or -id

Responses

• 200
• 401

---

Found

application/json

Schema

Example (from schema)

---

Schema

first string nullable required

The link to the first page.

items object[] required
An array of objects.
Array [
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
]
last string nullable required

The link to the last page.

next string nullable required

The link to the next page or null if there's no page.

prev string nullable required

The link to the previous page or null if there's no page.

self string nullable required

The link to the current page.

{
  "first": "string",
  "items": [
    {
      "created_at": "2024-11-19T00:12:35.616Z",
      "error_reason": "string",
      "has_errors": true,
      "id": 0,
      "merchant_id": 0,
      "modified_at": "2024-11-19T00:12:35.616Z",
      "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
    }
  ],
  "last": "string",
  "next": "string",
  "prev": "string",
  "self": "string"
}

Authentication Failure

Loading...