Get ShopTrackers

GET 
/trackers/{type?}

Returns ShopTrackers of the requested Company.

Request

Path Parameters

type string

Possible values: [normal, trashed, justtrashed]

Default value: normal

How to handle soft deleted ("archived") ShopTrackers.

"normal"

Returns all the ShopTrackers, except those which are soft deleted.

"trashed"

Returns all the ShopTrackers, including those which are soft deleted.

"justtrashed"

Returns only the ShopTrackers which are soft deleted.

Responses

200

ShopTrackers found.

application/json

Schema

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.

• ]

Example (from schema)

[
  {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "shop_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "code": "string",
    "name": "string",
    "description": "string",
    "type": "string",
    "clicks": 0,
    "created_at": "2023-08-01T14:40:24+00:00",
    "updated_at": "2023-08-01T14:40:24+00:00"
  }
]

403

Unauthorized. You do not have permission to retrieve the ShopTrackers of the requested Company.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

404

Company not found.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

Loading...