v1

latestOpenAPI 3.1.02026-07-24920300.7 KB

Create in Order

A request to this endpoint will create an Impulse Upsell order item on the specified order. This will be tracked by OrderGroove as an 'Impulse Upsell' order item.

post/items/iu/

Request body

orderstring required

Order ID

offerstring required

Offer ID

productstring required

Product ID

quantityinteger required

Number of items

contextsobject

Items contexts as key:value

Response

200

orderstring

{"stackTrail":"paths:/items/iu/:post:responses:200:content:application/json:schema:properties:offer","oasType":"schema","type":"unknown"}

subscriptionstring

productstring

subscription_componentstring

quantityinteger

public_idstring

{"stackTrail":"paths:/items/iu/:post:responses:200:content:application/json:schema:properties:product_attribute","oasType":"schema","type":"unknown"}

pricestring

extra_coststring

total_pricestring

one_timeboolean

order_updatedstring

frozenboolean

{"stackTrail":"paths:/items/iu/:post:responses:200:content:application/json:schema:properties:first_placed","oasType":"schema","type":"unknown"}

Example response

{
  "order": "45c27952cd9211e8855abc764e106cf4",
  "subscription": "6199282ccd8f11e88267bc764e106cf4",
  "product": "0070067698",
  "components": [
    {
      "product": "product_id_1"
    }
  ],
  "subscription_component": "85eae83c245111eeb185acde48001122",
  "quantity": 1,
  "public_id": "45c39ceccd9211e8855abc764e106cf4",
  "price": "79.99",
  "extra_cost": "0.00",
  "total_price": "35.99",
  "order_updated": "2025-01-31 00:00:00"
}