REST RPC APIItems

Create in Order

View as Markdown
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.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
orderstringRequired
Order ID
offerstringRequired
Offer ID
productstringRequired
Product ID
quantityintegerRequired
Number of items
contextsobjectOptional

Items contexts as key:value

componentslist of objectsOptional
Bundle components

Response

200
orderstringOptional
offerstring or nullOptional
subscriptionstringOptional
productstringOptional
componentslist of objectsOptional
subscription_componentstringOptional
quantityintegerOptionalDefaults to 0
public_idstringOptional
product_attributeanyOptional
pricestringOptional
extra_coststringOptional
total_pricestringOptional
one_timebooleanOptionalDefaults to true
order_updatedstringOptional
frozenbooleanOptionalDefaults to true
first_placedanyOptional

Errors

400
Bad Request Error
403
Forbidden Error