Skip to main content

Get by id

GET 
/merchants/:id

Get a Merchant by its id.

Request​

Path Parameters

    id int64required

    The Merchant id

Responses​

Success

Schema

    access_token stringrequired

    The Google merchant access token

    account_id int64

    The account id

    automatic_synchronization boolean

    Whether the Merchant data will be synchronized automatically

    created_at date-time

    The create date-time

    custom_seller string

    Custom seller entity - if applicable.

    dataset_domain stringdeprecated

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

    dataset_name stringdeprecated

    The dataset path (for example /data)

    default_products_filter_action stringrequired

    Possible values: [PROCESS, IGNORE]

    Default value: PROCESS

    Default Products filter action to apply during sync process.

    deleted booleanrequired

    True if the merchant has been deleted

    deleted_at date-time

    The delete date-time

    google_merchant_id int64required

    The Google Merchant id

    id int64

    The unique id

    ignore_brand boolean

    Whether to ignore the brand property during validation

    ignore_image boolean

    Whether to ignore the image property during validation

    modified_at date-time

    The last modified date-time

    publisher_name stringrequired

    The publisher name (shows in schema publisher)

    refresh_token stringrequired

    The Google merchant refresh token

    url string

    The website URL

    url_strategy string

    Possible values: <= 50 characters, [canonicalLinkAndLink, canonicalLinkOtherwiseLink]

    Default value: canonicalLinkAndLink

    Which strategy to use to write the url schema.

    writer_service string

    How to write the merchant data to the graph, if unsure, do not set anything (by default wordpressMerchantWriter).