Orders
Download SpecList 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
ApiKey
Responses
Response: application/json
items
array[object (TppOrder)]
required
page
integer
required
size
int
required
total
integer
required
Response: application/json
detail
array[object (ValidationError)]
Create Order For Provider Product
Create pricing for TPP Product. Products can have multiple pricing options
Authentication
ApiKey
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" }
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)]
Request Examples
Authentication
ApiKey
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" }
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)]
Authentication
ApiKey
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" }
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)]
Request Examples
Authentication
ApiKey
Responses
Response: application/json
detail
array[object (ValidationError)]
Authentication
ApiKey
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" }
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)]
Request Examples
List Orders With 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
ApiKey
Responses
Response: application/json
items
array[object (TppOrderAndCommission)]
required
page
integer
required
size
int
required
total
integer
required
Response: application/json
detail
array[object (ValidationError)]
Authentication
ApiKey
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)]
Update Cpa Order For Providers
Update CPA Order for particular CP.
Authentication
ApiKey
Responses
Response: application/json
Response: application/json
detail
array[object (ValidationError)]
Request Examples
Was this page helpful?