Orders

Download Spec

List Orders

get /orders

⚠ This functionality is only available to Providers.

Create, update, and delete new orders offered to customers on Marketplaces. Returns a paginated list of all orders.

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": [
    {
      "id": "string",
      "tpp_id": "string",
      "tpp_user_id": "string",
      "pricing_id": "string",
      "status": null,
      "meta": {},
      "input": {},
      "output": {},
      "prod_id": "string",
      "created": "2023-06-07T17:32:28Z",
      "updated": "2023-06-07T17:32:28Z",
      "user_id": "string",
      "value": 123,
      "currency": "string",
      "product": {
        "name": "Fibre Extra",
        "description": "Unlimited usage, 66Mb average download speed*",
        "enabled": 1,
        "product_type": "utilities_broadband",
        "meta": {
          "product_price": "£29",
          "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F",
          "product_billing_freq": "monthly",
          "product_activation_fee": "£0",
          "product_cashback_offer": "Free e-gift card worth up to £75 with  John Lewis Broadband",
          "product_contract_length": "12 months",
          "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.",
          "product_av_download_speed": "66mb/s"
        }
      },
      "root_quote_id": "string"
    }
  ],
  "total": null,
  "page": null,
  "size": 123
}

Not found

Empty response

Validation Error

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

items

array[object (TppOrder)]

required

TppOrder

object (TppOrder)

string

required

tpp_id

string

required

tpp_user_id

string

required

pricing_id

string

status

required

An enumeration.

meta

object (meta)

input

object (input)

output

object (output)

prod_id

string

created

string

date-time

updated

string

date-time

user_id

string

value

int

currency

string

product

object (product)

Example: { "name": "Fibre Extra", "description": "Unlimited usage, 66Mb average download speed*", "enabled": 1, "product_type": "utilities_broadband", "meta": { "product_price": "£29", "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F", "product_billing_freq": "monthly", "product_activation_fee": "£0", "product_cashback_offer": "Free e-gift card worth up to £75 with John Lewis Broadband", "product_contract_length": "12 months", "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.", "product_av_download_speed": "66mb/s" } }

name

string

required

description

string

expiration_date

string

date-time

enabled

boolean

product_type

required

An enumeration.

meta

Any Of

object

TppProductBroadbandMeta

object (TppProductBroadbandMeta)

Example: { "product_price": "£29", "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F", "thinkbroadband_key": "avail_retail_plusnet", "product_billing_freq": "monthly", "product_activation_fee": "£0", "product_cashback_offer": "Free e-gift card worth up to £75 with John Lewis Broadband", "product_contract_length": "12 months", "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.", "product_av_download_speed": "66mb/s" }

product_description_short

string

product_description_long

string

product_av_download_speed

string

product_av_upload_speed

string

product_price

number

product_billing_freq

string

product_contract_length

int

product_activation_fee

number

product_cashback_offer

string

product_offer_expiry

string

product_offer_start

string

product_offer_text

string

product_offer_length

string

product_cta

string

product_cpa

string

has_broadband

boolean

affiliate_link

string

required

external_short_name

string

student

int

business

string

rating

number

plus_vat

string

credit

string

original_monthly_cost

number

original_monthly_cost_text

string

original_setup_fee

number

full_contract_cost

number

effective_full_contract_cost

number

effective_monthly_cost

number

effective_first_year_cost

number

outlink

string

phone_number

string

switch_type

string

supplier_image

string

postage_cost

string

required

download_limit

string

required

landline

boolean

required

free_calls

string

required

phone_text

string

required

extras_text

string

required

boolean

required

tv_text

string

required

tv_icon_text

string

required

tv_package_description

string

required

tv_package_image

string

required

tv_total_channels

string

required

tv_bundles

array[object (HomeboxTvBundle)]

required

HomeboxTvBundle

object (HomeboxTvBundle)

name

string

required

tv_channels

array[object (HomeboxTvChannel)]

required

HomeboxTvChannel

object (HomeboxTvChannel)

name

string

required

logo

string

required

external_key

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

prices

array[object (TppProductPrice)]

TppProductPrice

object (TppProductPrice)

name

string

required

currency

string

required

amount

int

required

description

string

meta

object (meta)

type

An enumeration.

recurring_meta

object (recurring_meta)

string

required

tpp_id

string

required

prod_id

string

required

root_quote_id

string

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 Order For Provider Product

post /orders

Create pricing for TPP Product. Products can have multiple pricing options

API Key ApiKey

X-API-Key found in header

prod_id

string

pricing_id

string

user_id

string

required

meta

object (meta)

input

object (input)

output

object (output)

status

An enumeration.

external_key

string

value

int

currency

string

root_quote_id

string

Request

{
  "prod_id": "string",
  "pricing_id": "string",
  "user_id": "string",
  "meta": {},
  "input": {},
  "output": {},
  "status": null,
  "external_key": "string",
  "value": 123,
  "currency": "string",
  "root_quote_id": "string"
}

Response

Examples Schema

Successful Response

{
  "id": "string",
  "tpp_id": "string",
  "tpp_user_id": "string",
  "pricing_id": "string",
  "status": null,
  "meta": {},
  "input": {},
  "output": {},
  "prod_id": "string",
  "created": "2023-06-07T17:32:28Z",
  "updated": "2023-06-07T17:32:28Z",
  "user_id": "string",
  "value": 123,
  "currency": "string",
  "product": {
    "name": "Fibre Extra",
    "description": "Unlimited usage, 66Mb average download speed*",
    "enabled": 1,
    "product_type": "utilities_broadband",
    "meta": {
      "product_price": "£29",
      "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F",
      "product_billing_freq": "monthly",
      "product_activation_fee": "£0",
      "product_cashback_offer": "Free e-gift card worth up to £75 with  John Lewis Broadband",
      "product_contract_length": "12 months",
      "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.",
      "product_av_download_speed": "66mb/s"
    }
  },
  "root_quote_id": "string"
}

Not found

Empty response

Validation Error

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

string

required

tpp_id

string

required

tpp_user_id

string

required

pricing_id

string

status

required

An enumeration.

meta

object (meta)

input

object (input)

output

object (output)

prod_id

string

created

string

date-time

updated

string

date-time

user_id

string

value

int

currency

string

product

object (product)

Example: { "name": "Fibre Extra", "description": "Unlimited usage, 66Mb average download speed*", "enabled": 1, "product_type": "utilities_broadband", "meta": { "product_price": "£29", "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F", "product_billing_freq": "monthly", "product_activation_fee": "£0", "product_cashback_offer": "Free e-gift card worth up to £75 with John Lewis Broadband", "product_contract_length": "12 months", "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.", "product_av_download_speed": "66mb/s" } }

name

string

required

description

string

expiration_date

string

date-time

enabled

boolean

product_type

required

An enumeration.

meta

Any Of

object

TppProductBroadbandMeta

object (TppProductBroadbandMeta)

Example: { "product_price": "£29", "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F", "thinkbroadband_key": "avail_retail_plusnet", "product_billing_freq": "monthly", "product_activation_fee": "£0", "product_cashback_offer": "Free e-gift card worth up to £75 with John Lewis Broadband", "product_contract_length": "12 months", "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.", "product_av_download_speed": "66mb/s" }

product_description_short

string

product_description_long

string

product_av_download_speed

string

product_av_upload_speed

string

product_price

number

product_billing_freq

string

product_contract_length

int

product_activation_fee

number

product_cashback_offer

string

product_offer_expiry

string

product_offer_start

string

product_offer_text

string

product_offer_length

string

product_cta

string

product_cpa

string

has_broadband

boolean

affiliate_link

string

required

external_short_name

string

student

int

business

string

rating

number

plus_vat

string

credit

string

original_monthly_cost

number

original_monthly_cost_text

string

original_setup_fee

number

full_contract_cost

number

effective_full_contract_cost

number

effective_monthly_cost

number

effective_first_year_cost

number

outlink

string

phone_number

string

switch_type

string

supplier_image

string

postage_cost

string

required

download_limit

string

required

landline

boolean

required

free_calls

string

required

phone_text

string

required

extras_text

string

required

boolean

required

tv_text

string

required

tv_icon_text

string

required

tv_package_description

string

required

tv_package_image

string

required

tv_total_channels

string

required

tv_bundles

array[object (HomeboxTvBundle)]

required

HomeboxTvBundle

object (HomeboxTvBundle)

name

string

required

tv_channels

array[object (HomeboxTvChannel)]

required

HomeboxTvChannel

object (HomeboxTvChannel)

name

string

required

logo

string

required

external_key

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

prices

array[object (TppProductPrice)]

TppProductPrice

object (TppProductPrice)

name

string

required

currency

string

required

amount

int

required

description

string

meta

object (meta)

type

An enumeration.

recurring_meta

object (recurring_meta)

string

required

tpp_id

string

required

prod_id

string

required

root_quote_id

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

Return A Specific Order

get /orders/{order_id}

Returns the associated order by a given order_id.

API Key ApiKey

X-API-Key found in header

order_id

string

required

Response

Examples Schema

Successful Response

{
  "id": "string",
  "tpp_id": "string",
  "tpp_user_id": "string",
  "pricing_id": "string",
  "status": null,
  "meta": {},
  "input": {},
  "output": {},
  "prod_id": "string",
  "created": "2023-06-07T17:32:28Z",
  "updated": "2023-06-07T17:32:28Z",
  "user_id": "string",
  "value": 123,
  "currency": "string",
  "product": {
    "name": "Fibre Extra",
    "description": "Unlimited usage, 66Mb average download speed*",
    "enabled": 1,
    "product_type": "utilities_broadband",
    "meta": {
      "product_price": "£29",
      "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F",
      "product_billing_freq": "monthly",
      "product_activation_fee": "£0",
      "product_cashback_offer": "Free e-gift card worth up to £75 with  John Lewis Broadband",
      "product_contract_length": "12 months",
      "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.",
      "product_av_download_speed": "66mb/s"
    }
  },
  "root_quote_id": "string"
}

Not found

Empty response

Validation Error

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

string

required

tpp_id

string

required

tpp_user_id

string

required

pricing_id

string

status

required

An enumeration.

meta

object (meta)

input

object (input)

output

object (output)

prod_id

string

created

string

date-time

updated

string

date-time

user_id

string

value

int

currency

string

product

object (product)

Example: { "name": "Fibre Extra", "description": "Unlimited usage, 66Mb average download speed*", "enabled": 1, "product_type": "utilities_broadband", "meta": { "product_price": "£29", "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F", "product_billing_freq": "monthly", "product_activation_fee": "£0", "product_cashback_offer": "Free e-gift card worth up to £75 with John Lewis Broadband", "product_contract_length": "12 months", "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.", "product_av_download_speed": "66mb/s" } }

name

string

required

description

string

expiration_date

string

date-time

enabled

boolean

product_type

required

An enumeration.

meta

Any Of

object

TppProductBroadbandMeta

object (TppProductBroadbandMeta)

Example: { "product_price": "£29", "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F", "thinkbroadband_key": "avail_retail_plusnet", "product_billing_freq": "monthly", "product_activation_fee": "£0", "product_cashback_offer": "Free e-gift card worth up to £75 with John Lewis Broadband", "product_contract_length": "12 months", "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.", "product_av_download_speed": "66mb/s" }

product_description_short

string

product_description_long

string

product_av_download_speed

string

product_av_upload_speed

string

product_price

number

product_billing_freq

string

product_contract_length

int

product_activation_fee

number

product_cashback_offer

string

product_offer_expiry

string

product_offer_start

string

product_offer_text

string

product_offer_length

string

product_cta

string

product_cpa

string

has_broadband

boolean

affiliate_link

string

required

external_short_name

string

student

int

business

string

rating

number

plus_vat

string

credit

string

original_monthly_cost

number

original_monthly_cost_text

string

original_setup_fee

number

full_contract_cost

number

effective_full_contract_cost

number

effective_monthly_cost

number

effective_first_year_cost

number

outlink

string

phone_number

string

switch_type

string

supplier_image

string

postage_cost

string

required

download_limit

string

required

landline

boolean

required

free_calls

string

required

phone_text

string

required

extras_text

string

required

boolean

required

tv_text

string

required

tv_icon_text

string

required

tv_package_description

string

required

tv_package_image

string

required

tv_total_channels

string

required

tv_bundles

array[object (HomeboxTvBundle)]

required

HomeboxTvBundle

object (HomeboxTvBundle)

name

string

required

tv_channels

array[object (HomeboxTvChannel)]

required

HomeboxTvChannel

object (HomeboxTvChannel)

name

string

required

logo

string

required

external_key

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

prices

array[object (TppProductPrice)]

TppProductPrice

object (TppProductPrice)

name

string

required

currency

string

required

amount

int

required

description

string

meta

object (meta)

type

An enumeration.

recurring_meta

object (recurring_meta)

string

required

tpp_id

string

required

prod_id

string

required

root_quote_id

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

Update Order

post /orders/{order_id}

Updates an order

API Key ApiKey

X-API-Key found in header

order_id

string

required

prod_id

string

pricing_id

string

user_id

string

meta

object (meta)

input

object (input)

output

object (output)

status

An enumeration.

external_key

string

value

int

currency

string

root_quote_id

string

Request

{
  "prod_id": "string",
  "pricing_id": "string",
  "user_id": "string",
  "meta": {},
  "input": {},
  "output": {},
  "status": null,
  "external_key": "string",
  "value": 123,
  "currency": "string",
  "root_quote_id": "string"
}

Response

Examples Schema

Successful Response

{
  "id": "string",
  "tpp_id": "string",
  "tpp_user_id": "string",
  "pricing_id": "string",
  "status": null,
  "meta": {},
  "input": {},
  "output": {},
  "prod_id": "string",
  "created": "2023-06-07T17:32:28Z",
  "updated": "2023-06-07T17:32:28Z",
  "user_id": "string",
  "value": 123,
  "currency": "string",
  "product": {
    "name": "Fibre Extra",
    "description": "Unlimited usage, 66Mb average download speed*",
    "enabled": 1,
    "product_type": "utilities_broadband",
    "meta": {
      "product_price": "£29",
      "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F",
      "product_billing_freq": "monthly",
      "product_activation_fee": "£0",
      "product_cashback_offer": "Free e-gift card worth up to £75 with  John Lewis Broadband",
      "product_contract_length": "12 months",
      "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.",
      "product_av_download_speed": "66mb/s"
    }
  },
  "root_quote_id": "string"
}

Not found

Empty response

Validation Error

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

string

required

tpp_id

string

required

tpp_user_id

string

required

pricing_id

string

status

required

An enumeration.

meta

object (meta)

input

object (input)

output

object (output)

prod_id

string

created

string

date-time

updated

string

date-time

user_id

string

value

int

currency

string

product

object (product)

Example: { "name": "Fibre Extra", "description": "Unlimited usage, 66Mb average download speed*", "enabled": 1, "product_type": "utilities_broadband", "meta": { "product_price": "£29", "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F", "product_billing_freq": "monthly", "product_activation_fee": "£0", "product_cashback_offer": "Free e-gift card worth up to £75 with John Lewis Broadband", "product_contract_length": "12 months", "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.", "product_av_download_speed": "66mb/s" } }

name

string

required

description

string

expiration_date

string

date-time

enabled

boolean

product_type

required

An enumeration.

meta

Any Of

object

TppProductBroadbandMeta

object (TppProductBroadbandMeta)

Example: { "product_price": "£29", "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F", "thinkbroadband_key": "avail_retail_plusnet", "product_billing_freq": "monthly", "product_activation_fee": "£0", "product_cashback_offer": "Free e-gift card worth up to £75 with John Lewis Broadband", "product_contract_length": "12 months", "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.", "product_av_download_speed": "66mb/s" }

product_description_short

string

product_description_long

string

product_av_download_speed

string

product_av_upload_speed

string

product_price

number

product_billing_freq

string

product_contract_length

int

product_activation_fee

number

product_cashback_offer

string

product_offer_expiry

string

product_offer_start

string

product_offer_text

string

product_offer_length

string

product_cta

string

product_cpa

string

has_broadband

boolean

affiliate_link

string

required

external_short_name

string

student

int

business

string

rating

number

plus_vat

string

credit

string

original_monthly_cost

number

original_monthly_cost_text

string

original_setup_fee

number

full_contract_cost

number

effective_full_contract_cost

number

effective_monthly_cost

number

effective_first_year_cost

number

outlink

string

phone_number

string

switch_type

string

supplier_image

string

postage_cost

string

required

download_limit

string

required

landline

boolean

required

free_calls

string

required

phone_text

string

required

extras_text

string

required

boolean

required

tv_text

string

required

tv_icon_text

string

required

tv_package_description

string

required

tv_package_image

string

required

tv_total_channels

string

required

tv_bundles

array[object (HomeboxTvBundle)]

required

HomeboxTvBundle

object (HomeboxTvBundle)

name

string

required

tv_channels

array[object (HomeboxTvChannel)]

required

HomeboxTvChannel

object (HomeboxTvChannel)

name

string

required

logo

string

required

external_key

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

prices

array[object (TppProductPrice)]

TppProductPrice

object (TppProductPrice)

name

string

required

currency

string

required

amount

int

required

description

string

meta

object (meta)

type

An enumeration.

recurring_meta

object (recurring_meta)

string

required

tpp_id

string

required

prod_id

string

required

root_quote_id

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

Delete Orders

delete /orders/{order_id}

Deletes Providers product orders.

API Key ApiKey

X-API-Key found in header

order_id

string

required

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

Update Order By External Key

put /orders/external_key/{external_key}

Update order by external key

API Key ApiKey

X-API-Key found in header

external_key

string

required

data

login_link

status

string

Request

{
  "data": null,
  "login_link": null,
  "status": "string"
}

Response

Examples Schema

Successful Response

{
  "id": "string",
  "tpp_id": "string",
  "tpp_user_id": "string",
  "pricing_id": "string",
  "status": null,
  "meta": {},
  "input": {},
  "output": {},
  "prod_id": "string",
  "created": "2023-06-07T17:32:28Z",
  "updated": "2023-06-07T17:32:28Z",
  "user_id": "string",
  "value": 123,
  "currency": "string",
  "product": {
    "name": "Fibre Extra",
    "description": "Unlimited usage, 66Mb average download speed*",
    "enabled": 1,
    "product_type": "utilities_broadband",
    "meta": {
      "product_price": "£29",
      "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F",
      "product_billing_freq": "monthly",
      "product_activation_fee": "£0",
      "product_cashback_offer": "Free e-gift card worth up to £75 with  John Lewis Broadband",
      "product_contract_length": "12 months",
      "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.",
      "product_av_download_speed": "66mb/s"
    }
  },
  "root_quote_id": "string"
}

Not found

Empty response

Validation Error

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

string

required

tpp_id

string

required

tpp_user_id

string

required

pricing_id

string

status

required

An enumeration.

meta

object (meta)

input

object (input)

output

object (output)

prod_id

string

created

string

date-time

updated

string

date-time

user_id

string

value

int

currency

string

product

object (product)

Example: { "name": "Fibre Extra", "description": "Unlimited usage, 66Mb average download speed*", "enabled": 1, "product_type": "utilities_broadband", "meta": { "product_price": "£29", "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F", "product_billing_freq": "monthly", "product_activation_fee": "£0", "product_cashback_offer": "Free e-gift card worth up to £75 with John Lewis Broadband", "product_contract_length": "12 months", "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.", "product_av_download_speed": "66mb/s" } }

name

string

required

description

string

expiration_date

string

date-time

enabled

boolean

product_type

required

An enumeration.

meta

Any Of

object

TppProductBroadbandMeta

object (TppProductBroadbandMeta)

Example: { "product_price": "£29", "affiliate_link": "https://www.awin1.com/cread.php?awinmid=4260&awinaffid=774713&clickref=John+Lewis+Broadband&ued=https%3A%2F%2Fwww.johnlewisbroadband.com%2F", "thinkbroadband_key": "avail_retail_plusnet", "product_billing_freq": "monthly", "product_activation_fee": "£0", "product_cashback_offer": "Free e-gift card worth up to £75 with John Lewis Broadband", "product_contract_length": "12 months", "product_description_long": "There’s no usage limit, so you can stream music and watch films while your other devices work away in the background. Fibre Extra is the next generation of internet connectivity, able to support your whole family as well as any Wi-Fi enabled devices at the same time, to make sure your connected home runs smoothly.", "product_av_download_speed": "66mb/s" }

product_description_short

string

product_description_long

string

product_av_download_speed

string

product_av_upload_speed

string

product_price

number

product_billing_freq

string

product_contract_length

int

product_activation_fee

number

product_cashback_offer

string

product_offer_expiry

string

product_offer_start

string

product_offer_text

string

product_offer_length

string

product_cta

string

product_cpa

string

has_broadband

boolean

affiliate_link

string

required

external_short_name

string

student

int

business

string

rating

number

plus_vat

string

credit

string

original_monthly_cost

number

original_monthly_cost_text

string

original_setup_fee

number

full_contract_cost

number

effective_full_contract_cost

number

effective_monthly_cost

number

effective_first_year_cost

number

outlink

string

phone_number

string

switch_type

string

supplier_image

string

postage_cost

string

required

download_limit

string

required

landline

boolean

required

free_calls

string

required

phone_text

string

required

extras_text

string

required

boolean

required

tv_text

string

required

tv_icon_text

string

required

tv_package_description

string

required

tv_package_image

string

required

tv_total_channels

string

required

tv_bundles

array[object (HomeboxTvBundle)]

required

HomeboxTvBundle

object (HomeboxTvBundle)

name

string

required

tv_channels

array[object (HomeboxTvChannel)]

required

HomeboxTvChannel

object (HomeboxTvChannel)

name

string

required

logo

string

required

external_key

string

required

tpp_id

string

required

created

string

date-time

required

updated

string

date-time

required

prices

array[object (TppProductPrice)]

TppProductPrice

object (TppProductPrice)

name

string

required

currency

string

required

amount

int

required

description

string

meta

object (meta)

type

An enumeration.

recurring_meta

object (recurring_meta)

string

required

tpp_id

string

required

prod_id

string

required

root_quote_id

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

List Orders With Commission

get /order_commission

⚠ This functionality is only available to Providers.

Create, update, and delete new orders offered to customers on Marketplaces. Returns a paginated list of all orders.

API Key ApiKey

X-API-Key found in header

date_from

string

date-time

date_to

string

date-time

order_sort

string

commission_sort

string

order_status[]

array[string]

string

commission_status[]

array[string]

string

page

integer

Default: 0

size

integer

Default: 50

Response

Examples Schema

Successful Response

{
  "items": [
    {
      "created": "2023-06-07T17:32:28Z",
      "updated": "2023-06-07T17:32:28Z",
      "id": "string",
      "tpp_id": "string",
      "tpp_user_id": "string",
      "pricing_id": "string",
      "prod_id": "string",
      "name": "string",
      "input": {},
      "output": {},
      "order_currency": "string",
      "order_value": 123,
      "order_status": null,
      "reason": "string",
      "payment_date": "2023-06-07T17:32:28Z",
      "commission_value": 123,
      "commission_status": null,
      "commission_currency": "string",
      "logo": "string"
    }
  ],
  "total": null,
  "page": null,
  "size": 123
}

Not found

Empty response

Validation Error

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

items

array[object (TppOrderAndCommission)]

required

TppOrderAndCommission

object (TppOrderAndCommission)

created

string

date-time

updated

string

date-time

string

tpp_id

string

tpp_user_id

string

pricing_id

string

prod_id

string

name

string

input

object (input)

output

object (output)

order_currency

string

order_value

int

order_status

An enumeration.

reason

string

payment_date

string

date-time

commission_value

int

commission_status

An enumeration.

commission_currency

string

logo

string

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

Get Cpa Order For Providers

get /orders/{order_id}/commission

Get CPA Order for particular CP.

API Key ApiKey

X-API-Key found in header

order_id

string

required

Response

Examples Schema

Successful Response

{
  "id": "string",
  "value": 123,
  "status": "string",
  "reason": "string",
  "payment_date": "2023-06-07T17:32:28Z",
  "paymode": "string",
  "currency": "string"
}

Not found

Empty response

Validation Error

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

string

value

int

status

string

reason

string

payment_date

string

date-time

paymode

string

currency

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

Update Cpa Order For Providers

post /orders/{order_id}/commission

Update CPA Order for particular CP.

API Key ApiKey

X-API-Key found in header

order_id

string

required

string

value

int

Default: 0

status

string

reason

string

payment_date

string

date-time

order_id

string

paymode

string

currency

string

Default: "GBP"

Request

{
  "id": "string",
  "value": 123,
  "status": "string",
  "reason": "string",
  "payment_date": "2023-06-07T17:32:28Z",
  "order_id": "string",
  "paymode": "string",
  "currency": "string"
}

Response

Examples Schema

Successful Response

null

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

Was this page helpful?