Distributions

List Distributions

get /distributions

Returns a paginated list of all distribution

API Key ApiKey

X-API-Key found in header

date_from

string

date-time

date_to

string

date-time

page

integer

Default: 0

size

integer

Default: 50

Response

Examples Schema

Successful Response

{
  "items": [
    {
      "name": "string",
      "prod_id": "string",
      "meta": {},
      "type": null,
      "tpp_yaml_id": "string",
      "id": "string",
      "tpp_id": "string",
      "created": "2023-06-07T17:32:28Z",
      "updated": "2023-06-07T17:32:28Z"
    }
  ],
  "total": null,
  "page": null,
  "size": 123
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

items

array[Any Of]

required

Any Of

TppDistributionJourneyResponse

object (TppDistributionJourneyResponse)

name

string

required

prod_id

string

meta

object (meta)

type

required

tpp_yaml_id

string

required

id

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

TppDistributionAffiliateResponse

object (TppDistributionAffiliateResponse)

name

string

required

prod_id

string

meta

object (meta)

type

required

cpa_amount

int

required

cpa_currency

required

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

cp_hint

string

required

affiliate_url

string

required

id

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

total

integer

required

page

integer

required

size

int

required

No schema

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.

API Key ApiKey

X-API-Key found in header

Distribution

Any Of

TppDistributionJourneyRequest

object (TppDistributionJourneyRequest)

name

string

required

prod_id

string

meta

object (meta)

type

string

required

Enum: journey

tpp_yaml_id

string

required

TppDistributionAffiliateRequest

object (TppDistributionAffiliateRequest)

name

string

required

prod_id

string

meta

object (meta)

type

string

required

Enum: affiliate

cpa_amount

int

required

cpa_currency

required

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

cp_hint

string

required

affiliate_url

string

required

Request

{
  "name": "string",
  "prod_id": "string",
  "meta": {},
  "type": "journey",
  "tpp_yaml_id": "string"
}

Response

Examples Schema

Successful Response

{
  "name": "string",
  "prod_id": "string",
  "meta": {},
  "type": null,
  "tpp_yaml_id": "string",
  "id": "string",
  "tpp_id": "string",
  "created": "2023-06-07T17:32:28Z",
  "updated": "2023-06-07T17:32:28Z"
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Response Create Distribution For Provider Product Distributions Post

Any Of

TppDistributionJourneyResponse

object (TppDistributionJourneyResponse)

name

string

required

prod_id

string

meta

object (meta)

type

required

tpp_yaml_id

string

required

id

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

TppDistributionAffiliateResponse

object (TppDistributionAffiliateResponse)

name

string

required

prod_id

string

meta

object (meta)

type

required

cpa_amount

int

required

cpa_currency

required

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

cp_hint

string

required

affiliate_url

string

required

id

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Get Distribution

get /distributions/{distribution_id}

Returns a paginated list of all distribution

API Key ApiKey

X-API-Key found in header

distribution_id

string

required

Response

Examples Schema

Successful Response

{
  "name": "string",
  "prod_id": "string",
  "meta": {},
  "type": null,
  "tpp_yaml_id": "string",
  "id": "string",
  "tpp_id": "string",
  "created": "2023-06-07T17:32:28Z",
  "updated": "2023-06-07T17:32:28Z"
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Response Get Distribution Distributions Distribution Id Get

Any Of

TppDistributionJourneyResponse

object (TppDistributionJourneyResponse)

name

string

required

prod_id

string

meta

object (meta)

type

required

tpp_yaml_id

string

required

id

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

TppDistributionAffiliateResponse

object (TppDistributionAffiliateResponse)

name

string

required

prod_id

string

meta

object (meta)

type

required

cpa_amount

int

required

cpa_currency

required

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

cp_hint

string

required

affiliate_url

string

required

id

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

No schema

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.

API Key ApiKey

X-API-Key found in header

distribution_id

string

required

Distribution

Any Of

TppDistributionJourneyRequest

object (TppDistributionJourneyRequest)

name

string

required

prod_id

string

meta

object (meta)

type

string

required

Enum: journey

tpp_yaml_id

string

required

TppDistributionAffiliateRequest

object (TppDistributionAffiliateRequest)

name

string

required

prod_id

string

meta

object (meta)

type

string

required

Enum: affiliate

cpa_amount

int

required

cpa_currency

required

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

cp_hint

string

required

affiliate_url

string

required

Request

{
  "name": "string",
  "prod_id": "string",
  "meta": {},
  "type": "journey",
  "tpp_yaml_id": "string"
}

Response

Examples Schema

Successful Response

{
  "name": "string",
  "prod_id": "string",
  "meta": {},
  "type": null,
  "tpp_yaml_id": "string",
  "id": "string",
  "tpp_id": "string",
  "created": "2023-06-07T17:32:28Z",
  "updated": "2023-06-07T17:32:28Z"
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Response Update Distribution For Provider Product Distributions Distribution Id Post

Any Of

TppDistributionJourneyResponse

object (TppDistributionJourneyResponse)

name

string

required

prod_id

string

meta

object (meta)

type

required

tpp_yaml_id

string

required

id

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

TppDistributionAffiliateResponse

object (TppDistributionAffiliateResponse)

name

string

required

prod_id

string

meta

object (meta)

type

required

cpa_amount

int

required

cpa_currency

required

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

cp_hint

string

required

affiliate_url

string

required

id

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Delete Distribution

delete /distributions/{distribution_id}

Returns a paginated list of all distribution

API Key ApiKey

X-API-Key found in header

distribution_id

string

required

page

integer

Default: 0

size

integer

Default: 50

Response

Examples Schema

Successful Response

Empty response

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required