Distributions

Download Spec

List Distributions

get /distributions

Returns a paginated list of all distribution

date_from

string

date-time

date_to

string

date-time

page

int

Default
0

size

int

Default
50

Response

ExamplesSchema

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": 123,
  "page": 123,
  "size": 123
}

Create Distribution For Provider Product

post /distributions

Create distribution for each offering.

Any Of

Content Type
application/json

Request

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

Response

ExamplesSchema

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"
}

Get Distribution

get /distributions/{distribution_id}

Returns a paginated list of all distribution

distribution_id

string

required

Response

ExamplesSchema

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"
}

Update Distribution For Provider Product

post /distributions/{distribution_id}

Create distribution for each offering.

Any Of

Content Type
application/json

Request

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

Response

ExamplesSchema

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"
}

Delete Distribution

delete /distributions/{distribution_id}

Returns a paginated list of all distribution

page

int

Default
0

size

int

Default
50

Response

ExamplesSchema

Successful Response

Empty response

Was this page helpful?