/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.
date_from
string
date_to
string
page
int
size
int
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": 123,
"page": 123,
"size": 123
}
/orders
Create pricing for TPP Product. Products can have multiple pricing options
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
{
"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"
}
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"
}
/orders/{order_id}
Returns the associated order by a given order_id
.
order_id
string
required
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"
}
/orders/{order_id}
Updates an order
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
{
"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"
}
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"
}
/orders/{order_id}
Deletes Providers
product orders.
order_id
string
required
Successful Response
Empty response
/orders/external_key/{external_key}
Update order by external key
data
login_link
status
string
{
"data": null,
"login_link": null,
"status": "string"
}
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"
}
/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.
date_from
string
date_to
string
order_sort
string
commission_sort
string
order_status[]
array [Order Status[]]
commission_status[]
array [Commission Status[]]
page
int
size
int
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": 123,
"page": 123,
"size": 123
}
/orders/{order_id}/commission
Get CPA Order for particular CP.
order_id
string
required
Successful Response
{
"id": "string",
"value": 123,
"status": "string",
"reason": "string",
"payment_date": "2023-06-07T17:32:28Z",
"paymode": "string",
"currency": "string"
}
/orders/{order_id}/commission
Update CPA Order for particular CP.
id
string
value
int
status
string
reason
string
payment_date
string
order_id
string
paymode
string
currency
string
{
"id": "string",
"value": 123,
"status": "string",
"reason": "string",
"payment_date": "2023-06-07T17:32:28Z",
"order_id": "string",
"paymode": "string",
"currency": "string"
}
Successful Response
null
Was this page helpful?