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.

date_from

string

date-time

date_to

string

date-time

page

integer

Default
0

size

integer

Default
50

Response

ExamplesSchema

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
}

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

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

ExamplesSchema

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

Return A Specific Order
get /orders/{order_id}

Returns the associated order by a given order_id.

order_id

string

required

Response

ExamplesSchema

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

Update Order
post /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

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

ExamplesSchema

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 Orders
delete /orders/{order_id}

Deletes Providers product orders.

order_id

string

required

Response

ExamplesSchema

Successful Response

Empty response

Update Order By External Key
put /orders/external_key/{external_key}

Update order by external key

data

login_link

status

string

Request

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

Response

ExamplesSchema

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

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.

date_from

string

date-time

date_to

string

date-time

order_sort

string

commission_sort

string

order_status[]

array[string]

commission_status[]

array[string]

page

integer

Default
0

size

integer

Default
50

Response

ExamplesSchema

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
}

Get Cpa Order For Providers
get /orders/{order_id}/commission

Get CPA Order for particular CP.

order_id

string

required

Response

ExamplesSchema

Successful Response

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

Update Cpa Order For Providers
post /orders/{order_id}/commission

Update CPA Order for particular CP.

id

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

ExamplesSchema

Successful Response

null

Was this page helpful?