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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🔐

Authentication

✔️ Application API Scope

✔️ Storefront API Scope (including with trust_level: recognized)

Response Body Definitions

NameTypeDescriptionExample
offerstringOffer ID"4a10a0e1738f46bf9d81be56ea6d8d85"
orderstringOrder ID"9e78860ef49c4a86861ca11f638e5488"
subscriptionstringSubscription ID"565998a03d7a4647971aab47f8c487f9"
productstringProduct ID"62900-W01"
componentsstringLegacy Bundle components[{"product": "product_id_1"}]
subscription_componentstring \nullNew Bundle Subscription Component ID
quantityintegerNumber of items2
public_idstringItem ID"f9cb2f93e1c845eb9de9eff46ddb3cbf"
product_attributestringDeprecated
pricestringItem price"12.99"
extra_coststring"1.00"
total_pricestringTotal price of item in order"9.20"
one_timebooleanIndicates if item order was result of Impulse Upsell functionalityfalse
order_updatedstringThe date and time the order this item belongs to was last updated. Format: YYYY-MM-DD HH:mm:ss"2025-01-31 00:00:00"
frozenbooleanfalse
first_placed
Body Params
string
required

Order ID

string
required

Offer ID

string
required

Product ID

int32
required

Number of items

components
array of objects

Bundle components

components
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json