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

Try it

Get Vendor Charges

cURL

curl --request GET \
  --url https://api.topsort.com/public/v1/billing-service/vendor-charges \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "interactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "interactionType": "Impression",
      "timestamp": "2023-11-07T05:31:56Z",
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "productId": "<string>",
      "vendorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "externalVendorId": "<string>",
      "globalId": "<string>"
    }
  ],
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "currencyCode": "<string>"
}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI.

Query Parameters

start_date · string<date-time> · required

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

end_date · string<date-time> · required

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

Response

200

application/json

Successful Response

data · VendorCharge · object[] · required

Show child attributes

data. interactionId · string<uuid> · 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. timestamp · string<date-time> · required

timestamp of the click

data. campaignId · string<uuid> · required

Campaign ID.

data. productId · string · required

The product ID in Topsort.

data. vendorId · string<uuid> · required

The vendor's internal ID in Topsort.

data. amount · integer · required

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

data. externalVendorId · string | null

The vendor's external ID in Marketplace.

data. globalId · string | null

Global identifier for grouping vendors across marketplaces.

startDate · string<date-time> · required

Query start date.

endDate · string<date-time> · required

Query end date.

currencyCode · string · required

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

Required string length: 3