MMOB
Environment:
MMOB
Environment:

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.

Authentication

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

Responses

Response: application/json

items

array[object (TppOrder)]

required

TppOrder

object (TppOrder)

created

string

date-time

currency

string

id

string

required

input

object (input)

meta

object (meta)

output

object (output)

pricing_id

string

prod_id

string

product

object (product)

Example
{ "description": "Unlimited usage, 66Mb average download speed*", "enabled": 1, "meta": { "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_activation_fee": "£0", "product_av_download_speed": "66mb/s", "product_billing_freq": "monthly", "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_price": "£29" }, "name": "Fibre Extra", "product_type": "utilities_broadband" }

created

string

date-time

required

description

string

enabled

boolean

expiration_date

string

date-time

external_key

string

id

string

required

meta

Any Of

object

TppProductBroadbandMeta

object (TppProductBroadbandMeta)

Example
{ "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_activation_fee": "£0", "product_av_download_speed": "66mb/s", "product_billing_freq": "monthly", "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_price": "£29", "thinkbroadband_key": "avail_retail_plusnet" }

affiliate_link

string

required

business

string

credit

string

download_limit

string

required

effective_first_year_cost

number

effective_full_contract_cost

number

effective_monthly_cost

number

external_short_name

string

extras_text

string

required

free_calls

string

required

full_contract_cost

number

has_broadband

boolean

landline

boolean

required

original_monthly_cost

number

original_monthly_cost_text

string

original_setup_fee

number

outlink

string

phone_number

string

phone_text

string

required

plus_vat

string

postage_cost

string

required

product_activation_fee

number

product_av_download_speed

string

product_av_upload_speed

string

product_billing_freq

string

product_cashback_offer

string

product_contract_length

int

product_cpa

string

product_cta

string

product_description_long

string

product_description_short

string

product_offer_expiry

string

product_offer_length

string

product_offer_start

string

product_offer_text

string

product_price

number

rating

number

student

int

supplier_image

string

switch_type

string

tv

boolean

required

tv_bundles

array[object (HomeboxTvBundle)]

required

HomeboxTvBundle

object (HomeboxTvBundle)

name

string

required

tv_channels

array[object (HomeboxTvChannel)]

required

HomeboxTvChannel

object (HomeboxTvChannel)

logo

string

required

name

string

required

tv_icon_text

string

required

tv_package_description

string

required

tv_package_image

string

required

tv_text

string

required

tv_total_channels

string

required

name

string

required

prices

array[object (TppProductPrice)]

TppProductPrice

object (TppProductPrice)

amount

int

required

currency

string

required

description

string

id

string

required

meta

object (meta)

name

string

required

prod_id

string

required

recurring_meta

object (recurring_meta)

tpp_id

string

required

type

An enumeration.

product_type

required

An enumeration.

tpp_id

string

required

updated

string

date-time

required

root_quote_id

string

status

required

An enumeration.

tpp_id

string

required

tpp_user_id

string

required

updated

string

date-time

user_id

string

value

int

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

post /orders

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

Authentication

API Key ApiKey

X-API-Key found in header

application/json

currency

string

external_key

string

input

object (input)

meta

object (meta)

output

object (output)

pricing_id

string

prod_id

string

root_quote_id

string

status

An enumeration.

user_id

string

required

value

int

Responses

Response: application/json

created

string

date-time

currency

string

id

string

required

input

object (input)

meta

object (meta)

output

object (output)

pricing_id

string

prod_id

string

product

object (product)

Example
{ "description": "Unlimited usage, 66Mb average download speed*", "enabled": 1, "meta": { "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_activation_fee": "£0", "product_av_download_speed": "66mb/s", "product_billing_freq": "monthly", "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_price": "£29" }, "name": "Fibre Extra", "product_type": "utilities_broadband" }

created

string

date-time

required

description

string

enabled

boolean

expiration_date

string

date-time

external_key

string

id

string

required

meta

Any Of

object

TppProductBroadbandMeta

object (TppProductBroadbandMeta)

Example
{ "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_activation_fee": "£0", "product_av_download_speed": "66mb/s", "product_billing_freq": "monthly", "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_price": "£29", "thinkbroadband_key": "avail_retail_plusnet" }

affiliate_link

string

required

business

string

credit

string

download_limit

string

required

effective_first_year_cost

number

effective_full_contract_cost

number

effective_monthly_cost

number

external_short_name

string

extras_text

string

required

free_calls

string

required

full_contract_cost

number

has_broadband

boolean

landline

boolean

required

original_monthly_cost

number

original_monthly_cost_text

string

original_setup_fee

number

outlink

string

phone_number

string

phone_text

string

required

plus_vat

string

postage_cost

string

required

product_activation_fee

number

product_av_download_speed

string

product_av_upload_speed

string

product_billing_freq

string

product_cashback_offer

string

product_contract_length

int

product_cpa

string

product_cta

string

product_description_long

string

product_description_short

string

product_offer_expiry

string

product_offer_length

string

product_offer_start

string

product_offer_text

string

product_price

number

rating

number

student

int

supplier_image

string

switch_type

string

tv

boolean

required

tv_bundles

array[object (HomeboxTvBundle)]

required

HomeboxTvBundle

object (HomeboxTvBundle)

name

string

required

tv_channels

array[object (HomeboxTvChannel)]

required

HomeboxTvChannel

object (HomeboxTvChannel)

logo

string

required

name

string

required

tv_icon_text

string

required

tv_package_description

string

required

tv_package_image

string

required

tv_text

string

required

tv_total_channels

string

required

name

string

required

prices

array[object (TppProductPrice)]

TppProductPrice

object (TppProductPrice)

amount

int

required

currency

string

required

description

string

id

string

required

meta

object (meta)

name

string

required

prod_id

string

required

recurring_meta

object (recurring_meta)

tpp_id

string

required

type

An enumeration.

product_type

required

An enumeration.

tpp_id

string

required

updated

string

date-time

required

root_quote_id

string

status

required

An enumeration.

tpp_id

string

required

tpp_user_id

string

required

updated

string

date-time

user_id

string

value

int

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

Return A Specific Order

get /orders/{order_id}

Returns the associated order by a given order_id.

Authentication

API Key ApiKey

X-API-Key found in header

order_id

string

required

Responses

Response: application/json

created

string

date-time

currency

string

id

string

required

input

object (input)

meta

object (meta)

output

object (output)

pricing_id

string

prod_id

string

product

object (product)

Example
{ "description": "Unlimited usage, 66Mb average download speed*", "enabled": 1, "meta": { "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_activation_fee": "£0", "product_av_download_speed": "66mb/s", "product_billing_freq": "monthly", "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_price": "£29" }, "name": "Fibre Extra", "product_type": "utilities_broadband" }

created

string

date-time

required

description

string

enabled

boolean

expiration_date

string

date-time

external_key

string

id

string

required

meta

Any Of

object

TppProductBroadbandMeta

object (TppProductBroadbandMeta)

Example
{ "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_activation_fee": "£0", "product_av_download_speed": "66mb/s", "product_billing_freq": "monthly", "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_price": "£29", "thinkbroadband_key": "avail_retail_plusnet" }

affiliate_link

string

required

business

string

credit

string

download_limit

string

required

effective_first_year_cost

number

effective_full_contract_cost

number

effective_monthly_cost

number

external_short_name

string

extras_text

string

required

free_calls

string

required

full_contract_cost

number

has_broadband

boolean

landline

boolean

required

original_monthly_cost

number

original_monthly_cost_text

string

original_setup_fee

number

outlink

string

phone_number

string

phone_text

string

required

plus_vat

string

postage_cost

string

required

product_activation_fee

number

product_av_download_speed

string

product_av_upload_speed

string

product_billing_freq

string

product_cashback_offer

string

product_contract_length

int

product_cpa

string

product_cta

string

product_description_long

string

product_description_short

string

product_offer_expiry

string

product_offer_length

string

product_offer_start

string

product_offer_text

string

product_price

number

rating

number

student

int

supplier_image

string

switch_type

string

tv

boolean

required

tv_bundles

array[object (HomeboxTvBundle)]

required

HomeboxTvBundle

object (HomeboxTvBundle)

name

string

required

tv_channels

array[object (HomeboxTvChannel)]

required

HomeboxTvChannel

object (HomeboxTvChannel)

logo

string

required

name

string

required

tv_icon_text

string

required

tv_package_description

string

required

tv_package_image

string

required

tv_text

string

required

tv_total_channels

string

required

name

string

required

prices

array[object (TppProductPrice)]

TppProductPrice

object (TppProductPrice)

amount

int

required

currency

string

required

description

string

id

string

required

meta

object (meta)

name

string

required

prod_id

string

required

recurring_meta

object (recurring_meta)

tpp_id

string

required

type

An enumeration.

product_type

required

An enumeration.

tpp_id

string

required

updated

string

date-time

required

root_quote_id

string

status

required

An enumeration.

tpp_id

string

required

tpp_user_id

string

required

updated

string

date-time

user_id

string

value

int

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 Order

post /orders/{order_id}

Updates an order

Authentication

API Key ApiKey

X-API-Key found in header

order_id

string

required

application/json

currency

string

external_key

string

input

object (input)

meta

object (meta)

output

object (output)

pricing_id

string

prod_id

string

root_quote_id

string

status

An enumeration.

user_id

string

value

int

Responses

Response: application/json

created

string

date-time

currency

string

id

string

required

input

object (input)

meta

object (meta)

output

object (output)

pricing_id

string

prod_id

string

product

object (product)

Example
{ "description": "Unlimited usage, 66Mb average download speed*", "enabled": 1, "meta": { "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_activation_fee": "£0", "product_av_download_speed": "66mb/s", "product_billing_freq": "monthly", "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_price": "£29" }, "name": "Fibre Extra", "product_type": "utilities_broadband" }

created

string

date-time

required

description

string

enabled

boolean

expiration_date

string

date-time

external_key

string

id

string

required

meta

Any Of

object

TppProductBroadbandMeta

object (TppProductBroadbandMeta)

Example
{ "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_activation_fee": "£0", "product_av_download_speed": "66mb/s", "product_billing_freq": "monthly", "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_price": "£29", "thinkbroadband_key": "avail_retail_plusnet" }

affiliate_link

string

required

business

string

credit

string

download_limit

string

required

effective_first_year_cost

number

effective_full_contract_cost

number

effective_monthly_cost

number

external_short_name

string

extras_text

string

required

free_calls

string

required

full_contract_cost

number

has_broadband

boolean

landline

boolean

required

original_monthly_cost

number

original_monthly_cost_text

string

original_setup_fee

number

outlink

string

phone_number

string

phone_text

string

required

plus_vat

string

postage_cost

string

required

product_activation_fee

number

product_av_download_speed

string

product_av_upload_speed

string

product_billing_freq

string

product_cashback_offer

string

product_contract_length

int

product_cpa

string

product_cta

string

product_description_long

string

product_description_short

string

product_offer_expiry

string

product_offer_length

string

product_offer_start

string

product_offer_text

string

product_price

number

rating

number

student

int

supplier_image

string

switch_type

string

tv

boolean

required

tv_bundles

array[object (HomeboxTvBundle)]

required

HomeboxTvBundle

object (HomeboxTvBundle)

name

string

required

tv_channels

array[object (HomeboxTvChannel)]

required

HomeboxTvChannel

object (HomeboxTvChannel)

logo

string

required

name

string

required

tv_icon_text

string

required

tv_package_description

string

required

tv_package_image

string

required

tv_text

string

required

tv_total_channels

string

required

name

string

required

prices

array[object (TppProductPrice)]

TppProductPrice

object (TppProductPrice)

amount

int

required

currency

string

required

description

string

id

string

required

meta

object (meta)

name

string

required

prod_id

string

required

recurring_meta

object (recurring_meta)

tpp_id

string

required

type

An enumeration.

product_type

required

An enumeration.

tpp_id

string

required

updated

string

date-time

required

root_quote_id

string

status

required

An enumeration.

tpp_id

string

required

tpp_user_id

string

required

updated

string

date-time

user_id

string

value

int

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 Orders

delete /orders/{order_id}

Deletes Providers product orders.

Authentication

API Key ApiKey

X-API-Key found in header

order_id

string

required

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

Update Order By External Key

put /orders/external_key/{external_key}

Update order by external key

Authentication

API Key ApiKey

X-API-Key found in header

external_key

string

required

application/json

data

login_link

status

string

Responses

Response: application/json

created

string

date-time

currency

string

id

string

required

input

object (input)

meta

object (meta)

output

object (output)

pricing_id

string

prod_id

string

product

object (product)

Example
{ "description": "Unlimited usage, 66Mb average download speed*", "enabled": 1, "meta": { "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_activation_fee": "£0", "product_av_download_speed": "66mb/s", "product_billing_freq": "monthly", "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_price": "£29" }, "name": "Fibre Extra", "product_type": "utilities_broadband" }

created

string

date-time

required

description

string

enabled

boolean

expiration_date

string

date-time

external_key

string

id

string

required

meta

Any Of

object

TppProductBroadbandMeta

object (TppProductBroadbandMeta)

Example
{ "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_activation_fee": "£0", "product_av_download_speed": "66mb/s", "product_billing_freq": "monthly", "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_price": "£29", "thinkbroadband_key": "avail_retail_plusnet" }

affiliate_link

string

required

business

string

credit

string

download_limit

string

required

effective_first_year_cost

number

effective_full_contract_cost

number

effective_monthly_cost

number

external_short_name

string

extras_text

string

required

free_calls

string

required

full_contract_cost

number

has_broadband

boolean

landline

boolean

required

original_monthly_cost

number

original_monthly_cost_text

string

original_setup_fee

number

outlink

string

phone_number

string

phone_text

string

required

plus_vat

string

postage_cost

string

required

product_activation_fee

number

product_av_download_speed

string

product_av_upload_speed

string

product_billing_freq

string

product_cashback_offer

string

product_contract_length

int

product_cpa

string

product_cta

string

product_description_long

string

product_description_short

string

product_offer_expiry

string

product_offer_length

string

product_offer_start

string

product_offer_text

string

product_price

number

rating

number

student

int

supplier_image

string

switch_type

string

tv

boolean

required

tv_bundles

array[object (HomeboxTvBundle)]

required

HomeboxTvBundle

object (HomeboxTvBundle)

name

string

required

tv_channels

array[object (HomeboxTvChannel)]

required

HomeboxTvChannel

object (HomeboxTvChannel)

logo

string

required

name

string

required

tv_icon_text

string

required

tv_package_description

string

required

tv_package_image

string

required

tv_text

string

required

tv_total_channels

string

required

name

string

required

prices

array[object (TppProductPrice)]

TppProductPrice

object (TppProductPrice)

amount

int

required

currency

string

required

description

string

id

string

required

meta

object (meta)

name

string

required

prod_id

string

required

recurring_meta

object (recurring_meta)

tpp_id

string

required

type

An enumeration.

product_type

required

An enumeration.

tpp_id

string

required

updated

string

date-time

required

root_quote_id

string

status

required

An enumeration.

tpp_id

string

required

tpp_user_id

string

required

updated

string

date-time

user_id

string

value

int

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

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.

Authentication

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

Responses

Response: application/json

items

array[object (TppOrderAndCommission)]

required

TppOrderAndCommission

object (TppOrderAndCommission)

commission_currency

string

commission_status

An enumeration.

commission_value

int

created

string

date-time

id

string

input

object (input)

logo

string

name

string

order_currency

string

order_status

An enumeration.

order_value

int

output

object (output)

payment_date

string

date-time

pricing_id

string

prod_id

string

reason

string

tpp_id

string

tpp_user_id

string

updated

string

date-time

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

Get Cpa Order For Providers

get /orders/{order_id}/commission

Get CPA Order for particular CP.

Authentication

API Key ApiKey

X-API-Key found in header

order_id

string

required

Responses

Response: application/json

currency

string

id

string

payment_date

string

date-time

paymode

string

reason

string

status

string

value

int

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 Cpa Order For Providers

post /orders/{order_id}/commission

Update CPA Order for particular CP.

Authentication

API Key ApiKey

X-API-Key found in header

order_id

string

required

application/json

currency

string

Default
"GBP"

id

string

order_id

string

payment_date

string

date-time

paymode

string

reason

string

status

string

value

int

Default
0

Responses

Response: application/json

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

Was this page helpful?