LIliftforward
Products

Update Product

Updates the Product identified by the product_id parameter with the provided attributes.

Many attributes returned by the products api are calculated by LiftForward or are used for critical operations and are not updatable.

Partial updates are supported. Only the attributes provided in the request will be updated. For example the following request will only update the unit_sale_price attribute of the product.

{
  "product": {
    "unit_sale_price": 299.99,
  }
}

The following request will only update the available attributes of the product.

{
  "product": {
    "available": false,
    "inventory_message": "This product is currently out of stock.",
    "inventory_help_message": "Please check back later for availability."
  }
}

Some values can be updated to null when a value if null is accepted. For example the following request will update the cart_max_quantity attribute to null.

{
  "product": {
    "cart_max_quantity": null
  }
}

updates to the following attributes are supported:

  • asset_url
  • available
  • browsable
  • cart_max_quantity
  • categories
  • contract_type
  • currency
  • deep_link
  • description_list
  • description
  • discontinued
  • european_article_number
  • inventory_help_message
  • inventory_message
  • inventory_type
  • manufacturer_part_number
  • manufacturer
  • net_unit_sale_price
  • product_name
  • sales_taxes_and_fees
  • unit_retail_price
  • unit_sale_price
  • cross_sells

If unit_sale_price is updated for a product that already has tax/fee levies and sales_taxes_and_fees is not provided, the stored levy amounts are recalculated proportionally from the new sale price using the existing levy rates.

put/products/{product_id}

Request

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

Path parameters

product_idstring required

Request body

Example request

{
  "product": {
    "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"
      },
      {
        "merchant_sku": "PRODUCT-1236"
      }
    ]
  }
}

Response

Update 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.