Billing API
Get Vendor Charges
Auction examples
- Running auctions
- Sponsored listings
- Sponsored banners
- Sponsored brands
Asset examples
Webhook examples
Toptimize
Assets API
Billing API
- GETGet Billing Contacts
- GETGet Billing Contact
- PUTUpsert Billing Contact
- GETGet Campaign Billing Contact
- PUTUpsert Campaign Billing Contact
- GETGet Marketplace Credit Limit
- POSTSet Marketplace Credit Limit
- PUTUpsert Vendor Billing Contact
- GETGet Vendor Charges
- GETGet Vendor Account Activity
- GETGet Vendor Balance
- POSTAdd Vendor Balance
- POSTBurn Vendor Balance
- GETGet Vendor Credit History
- GETGet Vendor Credit Limit
- POSTSet Vendor Credit Limit
- DELDelete Vendor Billing Contact
- GETGet Vendor Wallets
- POSTCreate Wallet
- POSTAdjust Wallet Balance
Campaign API
- GETGet Campaigns
- POSTCreate Campaign
- GETGet Campaign By Id
- DELDelete Campaign By Id
- PATCHUpdate Campaign By Id
- GETGet Campaign Bids
- POSTCreate Campaign Bids
- DELDelete Campaign Bid By Id
- PATCHUpdate Campaign Bid By Id
- POST[BETA] Get estimated clicks of a future campaign for a given vendor
- GETGet Products In Campaign
- GETGet Sponsored Products
Catalog API
Invitation API
Modal API
Reporting API
- GETGet Campaign Report
- GETGet Campaign Daily Report
- GETGet Campaign Report By Product
- GETGet Product Report
- GETGet Product Daily Report
- GETGet Marketplace Interactions Report
- GETGet Marketplace Report
- GETGet Marketplace Campaigns Kpis
- GETGet Marketplace Daily Report
- GETGet Marketplace Vendors Kpis
- GETGet Vendor Report
- GETGet Vendor Daily Report
Segments Service
Toppie API
- GET[BETA] Get Agency Account Balance
- GET[BETA] Get Agency Account Top-ups
- GET[BETA] Get Toppie Campaigns
- POST[BETA] Create Toppie Campaign
- GET[BETA] Get Toppie Campaign Details
- PATCH[BETA] Update Toppie Campaign
- GET[BETA] Get Toppie Campaign Bids
- GETList Account Products
- GETGet Agency Account Report
- GETGet Agency Account Activity
- GETGet Agency Account Campaigns
- GETGet Account Campaigns By Ids
- GETGet Agency Campaign Report
- GETGet Campaign Report Per Product
Billing API
Get Vendor Charges
Endpoint to Get Vendor Charges.
Please note this is a beta API and therefore it is subject to change.
GET
/
public
/
v1
/
billing-service
/
vendor-charges
curl --request GET \
--url https://api.topsort.com/public/v1/billing-service/vendor-charges
{
"currencyCode": "<string>",
"data": [
{
"amount": 123,
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalVendorId": "<string>",
"interactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"interactionType": "Impression",
"productId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"vendorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"endDate": "2023-11-07T05:31:56Z",
"startDate": "2023-11-07T05:31:56Z"
}
Query Parameters
The start of the date range for which to retrieve. Must include the Timezone definition.
The end of the date range for which to retrieve. Must include the Timezone definition.
Response
200
application/json
Successful Response
The marketplace currency's ISO 4217 code (e.g. USD).
Required string length:
3
Charged amount for a campaign. (In Local Marketplace Currency, ISO 4217 standard)
Campaign ID.
click uuid
The type of the Interaction ID used in Vendor Charge.
Available options:
Impression
, Click
, Exclusive Campaign
, Attributed Purchase
The product ID in Topsort.
timestamp of the click
The vendor's internal ID in Topsort.
The vendor's external ID in Marketplace.
Query end date.
Query start date.
curl --request GET \
--url https://api.topsort.com/public/v1/billing-service/vendor-charges
{
"currencyCode": "<string>",
"data": [
{
"amount": 123,
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalVendorId": "<string>",
"interactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"interactionType": "Impression",
"productId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"vendorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"endDate": "2023-11-07T05:31:56Z",
"startDate": "2023-11-07T05:31:56Z"
}