LIliftforward
Products

Create Product

Creates new Products in the merchant's Product Catalog. If a product with a value matching the merchant_sku already exists the existing product will be updated with the provided attributes.

When creating new products the LF system will assign a product_id value for the product. Typically this value will be {merchant_id}-{merchant_sku}. Given product_id is used as a url parameter any non url safe characters in the merchant_sku will be removed. For example a merchant sku of "SKU 123/456" will be converted to a product_id of "SKU123456". The merchant_sku value will remain unchanged.

The following attributes are calculated by LiftForward and are not assignable: installment_price, installment_count, residual_value, total_over_term, total_payment_to_buy_out, total_payment_to_trade_in, installment_service_fee, & total_installment_service_fee

If a merchant is looking to update only a few attributes of an existing product the Update Product endpoint is recommended.

post/products

Request

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

Request body

Example request

{
  "product": {
    "merchant_sku": "SUPER-PRODUCT-123",
    "product_name": "Super cool product",
    "unit_retail_price": 350,
    "unit_sale_price": 350,
    "net_unit_sale_price": 325,
    "currency": "USD",
    "cart_max_quantity": 1,
    "inventory_message": "Available Now",
    "inventory_help_message": "Available Now",
    "residual_value_category": "iPhone 16",
    "contract_type": "FINANCING",
    "manufacturer_part_number": "SMP3BP334S4",
    "european_article_number": "2658932154786",
    "manufacturer": "Apple",
    "description": "This is a super cool product that does many things.",
    "description_list": [
      "32 GB RAM",
      "5 TB Hard Drive",
      "Intel i9 CPU"
    ],
    "merchant_detail_page_url": "https://www.merchant.com/product/123456",
    "product_image_url": "https://www.merchant.com/product/123456/image.png",
    "browsable": true,
    "inventory_type": "NEVER",
    "sales_taxes_and_fees": [
      {
        "code": "VAT",
        "amount": 25
      }
    ],
    "categories": [
      {
        "category_name": "Electronics"
      }
    ],
    "cross_sells": [
      {
        "merchant_sku": "PRODUCT-1235"
      }
    ]
  }
}

Response

Create Product

Example response

{
  "product": {
    "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"
      }
    ]
  }
}

Changes

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