Get Vendor Charges

Endpoint to Get Vendor Charges.

Please note this is a beta API and therefore it is subject to change.

Query Parameters

start_date

string

required

The start of the date range for which to retrieve. Must include the Timezone definition.

end_date

string

required

The end of the date range for which to retrieve. Must include the Timezone definition.

Response

200

application/json

Successful Response

currencyCode

string

required

The marketplace currency's ISO 4217 code (e.g. USD).

Required string length: 3

data

object[]

required

Show child attributes

data.amount

integer

required

Charged amount for a campaign. (In Local Marketplace Currency, ISO 4217 standard)

data.campaignId

string

required

Campaign ID.

data.interactionId

string

required

click uuid

data.interactionType

enum<string>

required

The type of the Interaction ID used in Vendor Charge.

Available options:

Impression,

Click,

Exclusive Campaign,

Attributed Purchase

data.productId

string

required

The product ID in Topsort.

data.timestamp

string

required

timestamp of the click

data.vendorId

string

required

The vendor's internal ID in Topsort.

data.externalVendorId

string

The vendor's external ID in Marketplace.

endDate

string

required

Query end date.

startDate

string

required

Query start date.