Ordergroove Developer Documentation

curl -X POST https://restapi.ordergroove.com/items/create/ \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "merchant_id": "string",
  "customer_id": "string",
  "shipping_id": "string",
  "payment_id": "string",
  "offer_id": "string",
  "product_id": "string",
  "place_date": "string",
  "quantity": 1
}'

{
  "order": "45c27952cd9211e8855abc764e106cf4",
  "offer": null,
  "subscription": "6199282ccd8f11e88267bc764e106cf4",
  "product": "0070067698",
  "components": [],
  "subscription_component": "85eae83c245111eeb185acde48001122",
  "quantity": 1,
  "public_id": "45c39ceccd9211e8855abc764e106cf4",
  "price": "79.99",
  "extra_cost": "0.00",
  "total_price": "35.99",
  "one_time": false,
  "order_updated": "2025-01-31 00:00:00",
  "frozen": false
}

This endpoint locates an existing order using the specified place date, shipping, payment and customer parameters, adding an additional item to that order. If no order exists with these parameters, it will create a new order and add an item for that order.

Authentication

x-api-keystring

API Key authentication via header

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