clickouts api 0.0.1-dev

Host API documentation Click-Out Statistics API.

  • Contact: Shopr Team
  • License: N/A

Resources

clickout

Operations

Method and Path Description
POST /:fingerprint/clickouts

Create a new click-out. Requests are accepted for eventual processing.

status

Operations

Method and Path Description
GET /_internal_/ping

Ping in milliseconds.

GET /_internal_/status

Current health check status.

GET /_internal_/version

API version.

Headers

No headers

Imports

No imports

Enums

client_origin

Describes the client where the request for a clickout has originated.

shopr_website

The Shopr website

shopr_mobile_web

The Shopr website, but from a mobile.

shopr_iphone

IPhone native application.

shopr_ipad

Native application running on an IPad.

shopr_android

Android native application.

Models

clickout

Example Json: Minimal | Full

Represents an Offer click-out. It contains all the information needed to properly identify the offer, trace it ot the user navigating from search page, and relevant information about the offer at the click-out moment (e.g.: price, lowest price among other offers, etc.)

Field Type Required? Default Description
productId string Yes -

Product identifier

Example: 584f4c7f4cedfd0005e17c19

seller string Yes -

Seller/Retailer unique identifier

Example: klingel

sellerProductId string Yes -

Product as identifier given by the seller/retailer

Example: SAND003

price decimal Yes -

Offer price at the moment of the click-out

Example: 67.00

deepUrl string Yes -

Full product URL at the retailer side

Example: http://www.klingel.nl/ProductDisplay?langId=31&catalogId=1000100000&storeId=100003&partNumber=460741&colorId=rood&attrId=G&vcp=gcqdjikm13m8iz&refID=Klingel_NL/Shopr/Dames/Schoenen/Pumps/Klassieke_pumps/04919/50X/&emsrc=Produktportale

lowestPrice decimal Yes -

Lowest price among all offers

Example: 59.99

highestPrice decimal Yes -

Seller/Retailer unique identifier

Example: 87.00

offerCount integer No 1

Number of offers

Minimum: 1
Example: 5

offerPosition integer Yes -

Offer position among other offers (e.g.: first, second, etc.)

Minimum: 1
Example: 2

categoryId string Yes -

Category where the product was put into

Example: 1234

tracking tracking Yes -

Tracking information

creationTime date-time-iso8601 Yes -

When this click-out happened

Example: 2016-12-22T11:56:52Z

error_code

Example Json: Minimal | Full
Field Type Required? Default Description
code string Yes -

Machine readable code for this specific error message

Example: 100

localized_string_code string Yes -

A localized description of the error code

Example: Lowest price cannot be bigger than highest price

error_response

Example Json: Minimal | Full
Field Type Required? Default Description
message string No -

User-friendly message.

error_codes [error_code] Yes -

List of errors that may happened all together.

fingerprint string No -

The request fingerprint associated with this error.

status

Example Json: Minimal | Full

Response for ping, health check and version

Field Type Required? Default Description
response string Yes -

Example: 100ms | healthy | 0.0.1

tracking

Example Json: Minimal | Full

Series of attributes for tracking purposes

Field Type Required? Default Description
ipAddress string Yes -

origin client_origin Yes -

Client originating the order request essentially any of the values of the client_origin enum.

userAgent string No -

referrer string No -

Optional page referrer.

Unions

No unions