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
orderstring
offerany
subscriptionstring
productstring
componentslist of objects
subscription_componentstring
quantityintegerDefaults to 0
public_idstring
product_attributeany
pricestring
extra_coststring
total_pricestring
one_timebooleanDefaults to true
order_updatedstring
frozenbooleanDefaults to true
first_placedany

Errors

400
Bad Request Error
403
Forbidden Error