Skip to navigation
REST RPC APIItems

Create

View as Markdown

Adds an item to the order that matches the given place date, shipping address, payment and customer. If no order matches, creates a new order for the item.

When a merchant with prepaid subscriptions has turned off mixed prepaid orders, returns 400 if the matching order already contains an item from a prepaid subscription.

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.
merchant_idstringRequired
Merchant ID
customer_idstringRequired
Customer ID
shipping_idstringRequired
Shipping address record ID
payment_idstringRequired
Payment record ID
offer_idstringRequired
Offer ID
product_idstringRequired
Product ID
place_datestringRequired

Date for order placement, should be in MM/DD/YYYY format

quantityintegerRequired
Number of items
contextsobjectOptional

Items contexts as key:value

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