Environment:

Distributions

Download Spec

List Distributions

get /distributions

Returns a paginated list of all distribution

Authentication

API Key ApiKey

date_from

string

date-time

date_to

string

date-time

page

integer

Default
0

size

integer

Default
50

Responses

Response: application/json

items

array[Any Of]

required

Any Of

TppDistributionJourneyResponse

object (TppDistributionJourneyResponse)

created

string

date-time

required

id

string

required

meta

object (meta)

name

string

required

prod_id

string

tpp_id

string

required

tpp_yaml_id

string

required

type

required

updated

string

date-time

required

TppDistributionAffiliateResponse

object (TppDistributionAffiliateResponse)

affiliate_url

string

required

cp_hint

string

required

cpa_amount

int

required

cpa_currency

required

List of available currencies in ISO 4217 https://en.wikipedia.org/wiki/ISO_4217

created

string

date-time

required

id

string

required

meta

object (meta)

name

string

required

prod_id

string

tpp_id

string

required

type

required

updated

string

date-time

required

page

integer

required

size

int

required

total

integer

required

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Create Distribution For Provider Product

post /distributions

Create distribution for each offering.

Authentication

API Key ApiKey

application/json

TppDistributionJourneyRequest

object (TppDistributionJourneyRequest)

meta

object (meta)

name

string

required

prod_id

string

tpp_yaml_id

string

required

type

string

required

Enum
  • journey

TppDistributionAffiliateRequest

object (TppDistributionAffiliateRequest)

affiliate_url

string

required

cp_hint

string

required

cpa_amount

int

required

cpa_currency

required

List of available currencies in ISO 4217 https://en.wikipedia.org/wiki/ISO_4217

meta

object (meta)

name

string

required

prod_id

string

type

string

required

Enum
  • affiliate

Responses

Response: application/json

Response Create Distribution For Provider Product Distributions Post

Any Of

TppDistributionJourneyResponse

object (TppDistributionJourneyResponse)

created

string

date-time

required

id

string

required

meta

object (meta)

name

string

required

prod_id

string

tpp_id

string

required

tpp_yaml_id

string

required

type

required

updated

string

date-time

required

TppDistributionAffiliateResponse

object (TppDistributionAffiliateResponse)

affiliate_url

string

required

cp_hint

string

required

cpa_amount

int

required

cpa_currency

required

List of available currencies in ISO 4217 https://en.wikipedia.org/wiki/ISO_4217

created

string

date-time

required

id

string

required

meta

object (meta)

name

string

required

prod_id

string

tpp_id

string

required

type

required

updated

string

date-time

required

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

Get Distribution

get /distributions/{distribution_id}

Returns a paginated list of all distribution

Authentication

API Key ApiKey

distribution_id

string

required

Responses

Response: application/json

Response Get Distribution Distributions Distribution Id Get

Any Of

TppDistributionJourneyResponse

object (TppDistributionJourneyResponse)

created

string

date-time

required

id

string

required

meta

object (meta)

name

string

required

prod_id

string

tpp_id

string

required

tpp_yaml_id

string

required

type

required

updated

string

date-time

required

TppDistributionAffiliateResponse

object (TppDistributionAffiliateResponse)

affiliate_url

string

required

cp_hint

string

required

cpa_amount

int

required

cpa_currency

required

List of available currencies in ISO 4217 https://en.wikipedia.org/wiki/ISO_4217

created

string

date-time

required

id

string

required

meta

object (meta)

name

string

required

prod_id

string

tpp_id

string

required

type

required

updated

string

date-time

required

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Update Distribution For Provider Product

post /distributions/{distribution_id}

Create distribution for each offering.

Authentication

API Key ApiKey

distribution_id

string

required

application/json

TppDistributionJourneyRequest

object (TppDistributionJourneyRequest)

meta

object (meta)

name

string

required

prod_id

string

tpp_yaml_id

string

required

type

string

required

Enum
  • journey

TppDistributionAffiliateRequest

object (TppDistributionAffiliateRequest)

affiliate_url

string

required

cp_hint

string

required

cpa_amount

int

required

cpa_currency

required

List of available currencies in ISO 4217 https://en.wikipedia.org/wiki/ISO_4217

meta

object (meta)

name

string

required

prod_id

string

type

string

required

Enum
  • affiliate

Responses

Response: application/json

Response Update Distribution For Provider Product Distributions Distribution Id Post

Any Of

TppDistributionJourneyResponse

object (TppDistributionJourneyResponse)

created

string

date-time

required

id

string

required

meta

object (meta)

name

string

required

prod_id

string

tpp_id

string

required

tpp_yaml_id

string

required

type

required

updated

string

date-time

required

TppDistributionAffiliateResponse

object (TppDistributionAffiliateResponse)

affiliate_url

string

required

cp_hint

string

required

cpa_amount

int

required

cpa_currency

required

List of available currencies in ISO 4217 https://en.wikipedia.org/wiki/ISO_4217

created

string

date-time

required

id

string

required

meta

object (meta)

name

string

required

prod_id

string

tpp_id

string

required

type

required

updated

string

date-time

required

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

Delete Distribution

delete /distributions/{distribution_id}

Returns a paginated list of all distribution

Authentication

API Key ApiKey

distribution_id

string

required

page

integer

Default
0

size

integer

Default
50

Responses

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Was this page helpful?