Skip to main content

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

Responses

Found

Schema
  • first string nullable required

    The link to the first page.

  • items object[] required

    An array of objects.

  • Array [
  • access_token string required

    The Google merchant access token

  • account_id int64 required

    The account id

  • automatic_synchronization boolean required

    Whether the Merchant data will be synchronized automatically

  • created_at date-time required

    The create date-time

  • dataset_domain string required

    The custom domain (for example data.example.org)

  • dataset_name string required

    The dataset path (for example /data)

  • deleted boolean required

    Default value: false

    True if the merchant has been deleted

  • deleted_at date-time required

    The delete date-time

  • google_merchant_id int64 required

    The Google Merchant id

  • id int64 required

    The unique id

  • modified_at date-time required

    The last modified date-time

  • publisher_name string required

    The publisher name (shows in schema publisher)

  • refresh_token string required

    The Google merchant refresh token

  • sid string required
  • sync_has_errors boolean required
  • sync_id int64 required
  • sync_products_created int32 required
  • sync_products_deleted int32 required
  • sync_products_errored int32 required
  • sync_products_skipped int32 required
  • sync_products_total int32 required
  • sync_products_updated int32 required
  • sync_started_at date-time required

    The started date-time.

  • sync_stopped_at date-time required

    The stopped date-time.

  • url string required

    The 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.

Loading...