Skip to main content

Get all ShopTrackers

GET 
/trackers/:type

Returns all ShopTrackers of the requested Company. When there are no ShopTrackers an empty array will be returned. The "trashed" operation returns all ShopTrackers including deleted ShopTrackers. The "justtrashed" operation returns only the deleted ShopTrackers.

Note, "normal" will yield the same result as without a type.

Request​

Path Parameters

    type stringrequired

    Possible values: [normal, trashed, justtrashed]

    Type of operations for querying deleted ShopTrackers.

    "normal"
    Returns all the ShopTrackers except those which are deleted.
    "trashed"
    Returns all the ShopTrackers including those which are deleted.
    "justtrashed"
    Returns all and only the deleted ShopTrackers.

Responses​

ShopTrackers found.

Schema

  • Array [

    • guid uuidrequired

    The guid of the ShopTracker.

    shop_id uuid

    Possible values: <= 255 characters

    The guid of the Shop this ShopTracker belongs to.

    code stringrequired

    Possible values: <= 255 characters

    The code of the ShopTracker.

    name stringrequired

    Possible values: <= 255 characters

    The name of the ShopTracker.

    description string

    Possible values: <= 65536 characters

    The description of the ShopTracker.

    type stringrequired

    The type of the ShopTracker.

    extra_url_parameters stringdeprecated

    Possible values: <= 255 characters

    Any extra url parameters. Not used.

    clicks integer

    How many times the link of the ShopTracker is visited.

    created_at ISO 8601

    The time it was created.

    updated_at ISO 8601

    The time it was last updated.

  • ]

Loading...