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.

Storefront API Scope may authenticate with Trust Level Authentication (trust_level: recognized).

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

OR
authorizationstring

Storefront API Scope — client-side, scoped to one customer, sent as a signature in the authorization header. See Authentication.

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