Products

Index Products

Returns a paginated list of all the Products in the merchant's Product Catalog.

Using the merchant_sku parameter merchants can filter the results. Using the the page and per_page parameters merchants can paginate the results.

get/products

Request

  • Base URL
    https://api.liftforward.com
  • Auth
    API key in header Api-Key

Query parameters

pageinteger

Indicates which page of results to return.

per_pageinteger

Indicates the number of results to include in each page.

merchant_skustring

Filters the results by merchant_sku.

Response

Index Products

Example response

{
  "products": [
    {
      "product_id": "snzqb89yamhaqexyrkmj5j773fn",
      "product_name": "Super cool product",
      "description": "This is a super cool product that does many things.",
      "manufacturer": "Apple",
      "merchant_detail_page_url": "https://www.merchant.com/product/123456",
      "product_image_url": "https://www.merchant.com/product/123456/image.png",
      "manufacturer_part_number": "SMP3BP334S4",
      "merchant_sku": "SUPER-PRODUCT-123",
      "european_article_number": "2658932154786",
      "unit_retail_price": 350,
      "unit_sale_price": 350,
      "net_unit_sale_price": 325,
      "residual_value": 29.99,
      "total_over_term": 29.99,
      "total_payment_to_buy_out": 2030,
      "total_payment_to_trade_in": 2030,
      "unit_installment_payment": 9.91,
      "installment_service_fee": 9.95,
      "total_installment_service_fee": 9.95,
      "currency": "USD",
      "installment_count": 36,
      "cart_max_quantity": 1,
      "inventory_type": "NEVER",
      "browsable": true,
      "inventory_message": "Available Now",
      "inventory_help_message": "Available Now",
      "contract_type": "FINANCING",
      "service_type": "INSURANCE",
      "residual_value_category": "iPhone 16",
      "available_subscription_plans": [
        {
          "subscription_plan_id": "standard-plan-30",
          "program_code": "subscription-us",
          "plan_code": "standard",
          "plan_name": "Standard Plan",
          "plan_subtitle": "This is the basic plan.",
          "plan_summary": "Total financed amount when you upgrade is $2,090 and includes 25 months of payments. T&Cs, fees, charges & exclusions apply.",
          "financing_plan_type": "financing",
          "installment_count": 30,
          "installment_count_to_trade_in": 24,
          "unit_installment_payment": 9.91,
          "installment_payment": 9.91,
          "total_installment_payment": 9.91,
          "total_over_term": 2090,
          "installment_service_fee": 9.95,
          "residual_value": 29.99,
          "total_residual_value": 29.99,
          "total_payment_to_buy_out": 2030,
          "total_payment_to_trade_in": 2030,
          "currency": "USD"
        }
      ],
      "categories": [
        {
          "category_name": "Electronics"
        }
      ],
      "cross_sells": [
        {
          "merchant_sku": "PRODUCT-1235"
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_pages": 10,
    "total_records": 250
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.