List
List the Merchants, optionally filtering by the deleted
flag
Query Parameters
- cursor string required
The cursor
- limit integer required
Default value:
10
The maximum number of results
- deleted boolean required
Filter by the
deleted
flag
- 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 [access_token string requiredThe Google merchant access token
account_id int64 requiredThe account id
automatic_synchronization boolean requiredWhether the Merchant data will be synchronized automatically
created_at date-time requiredThe create date-time
dataset_domain string requiredThe custom domain (for example data.example.org)
dataset_name string requiredThe dataset path (for example /data)
deleted boolean requiredDefault value:
false
True if the merchant has been deleted
deleted_at date-time requiredThe delete date-time
google_merchant_id int64 requiredThe Google Merchant id
id int64 requiredThe unique id
modified_at date-time requiredThe last modified date-time
publisher_name string requiredThe publisher name (shows in schema publisher)
refresh_token string requiredThe Google merchant refresh token
sid string requiredsync_has_errors boolean requiredsync_id int64 requiredsync_products_created int32 requiredsync_products_deleted int32 requiredsync_products_errored int32 requiredsync_products_skipped int32 requiredsync_products_total int32 requiredsync_products_updated int32 requiredsync_started_at date-time requiredThe started date-time.
sync_stopped_at date-time requiredThe stopped date-time.
url string requiredThe website URL
]- 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": [
{
"access_token": "string",
"account_id": 0,
"automatic_synchronization": true,
"created_at": "2023-08-16T14:24:18.763Z",
"dataset_domain": "string",
"dataset_name": "string",
"deleted": false,
"deleted_at": "2023-08-16T14:24:18.763Z",
"google_merchant_id": 0,
"id": 0,
"modified_at": "2023-08-16T14:24:18.763Z",
"publisher_name": "string",
"refresh_token": "string",
"sid": "string",
"sync_has_errors": true,
"sync_id": 0,
"sync_products_created": 0,
"sync_products_deleted": 0,
"sync_products_errored": 0,
"sync_products_skipped": 0,
"sync_products_total": 0,
"sync_products_updated": 0,
"sync_started_at": "2023-08-16T14:24:18.763Z",
"sync_stopped_at": "2023-08-16T14:24:18.763Z",
"url": "string"
}
],
"last": "string",
"next": "string",
"prev": "string",
"self": "string"
}
Authentication Failure