Products

Download Spec

List Products
get /products

⚠ This functionality is only available to Providers.

Returns a list of your products that is offered to users on the Marketplace. The products are returned sorted by creation date, with the most recently created products appearing first.

order_sort

string

category

An enumeration.

name

string

page

int

Default
0

size

int

Default
50

Response

ExamplesSchema

Successful Response

{
  "items": [
    {
      "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"
      }
    }
  ],
  "total": 123,
  "page": 123,
  "size": 123
}

Create A New Product
post /products

Create a new product for your company

name

string

required

description

string

expiration_date

string

date-time

enabled

boolean

product_type

required

An enumeration.

meta

Any Of

external_key

string

Request

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

Response

ExamplesSchema

Successful Response

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

Return A Specific Product
get /products/{product_id}

Returns the associated product by a given product_id.

product_id

string

required

Response

ExamplesSchema

Successful Response

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

Update Product Details
post /products/{product_id}

Update product information given a product_id.

name

string

required

description

string

expiration_date

string

date-time

enabled

boolean

product_type

required

An enumeration.

meta

Any Of

external_key

string

Request

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

Response

ExamplesSchema

Successful Response

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

Delete Product
delete /products/{product_id}

Delete a product.

product_id

string

required

Response

ExamplesSchema

Successful Response

Empty response

Was this page helpful?