Orders

get

List 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_fromstring
Format
date-time
date_tostring
Format
date-time
pageint
Default
0
sizeint
Default
50

Responses

Response examples

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

Create Order For Provider Product

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

prod_idstring
pricing_idstring
user_idstring

required

metaobject (Meta)
inputobject (Input)
outputobject (Output)
status

An enumeration.

external_keystring
valueint
currencystring
root_quote_idstring

Responses

Request examples

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

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

Return A Specific Order

Returns the associated order by a given order_id.

order_idstring

required

Responses

Response examples

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

Update Order

Updates an order

prod_idstring
pricing_idstring
user_idstring
metaobject (Meta)
inputobject (Input)
outputobject (Output)
status

An enumeration.

external_keystring
valueint
currencystring
root_quote_idstring

Responses

Request examples

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

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

Delete Orders

Deletes Providers product orders.

order_idstring

required

Responses

Response examples

Successful Response

Empty response

put

Update Order By External Key

Update order by external key

data
login_link
statusstring

Responses

Request examples

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

Response examples

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

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.

date_fromstring
Format
date-time
date_tostring
Format
date-time
order_sortstring
commission_sortstring
order_status[]array [Order Status[]]
commission_status[]array [Commission Status[]]
pageint
Default
0
sizeint
Default
50

Responses

Response examples

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

Get Cpa Order For Providers

Get CPA Order for particular CP.

order_idstring

required

Responses

Response examples

Successful Response

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

Update Cpa Order For Providers

Update CPA Order for particular CP.

idstring
valueint
Default
0
statusstring
reasonstring
payment_datestring
Format
date-time
order_idstring
paymodestring
currencystring
Default
"GBP"

Responses

Request examples

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

Response examples

Successful Response

null

Was this page helpful?