Ordergroove Developer Documentation

curl -X PATCH https://restapi.ordergroove.com/subscriptions/subscription_public_id/change_product/ \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "product": "string"
}'

{
  "customer": "00026001",
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "product": "0070000693",
  "payment": "070001bc02fd11e99542bc764e1043b0",
  "shipping_address": "66c25cd0564011e9abc5bc764e107990",
  "offer": "a748aa648ac811e8af3bbc764e106cf4",
  "subscription_type": "replenishment",
  "components": [],
  "extra_data": {},
  "public_id": "607daa2accc811e88516bc764e106cf4",
  "quantity": 21,
  "price": null,
  "frequency_days": 180,
  "reminder_days": 10,
  "every": 6,
  "every_period": 3,
  "start_date": "2018-12-27",
  "cancelled": null,
  "cancel_reason": null,
  "cancel_reason_code": null,
  "session_id": "ac4f7938383a11e89ecbbc764e1107f2.896371.1539022086",
  "merchant_order_id": "2906548",
  "customer_rep": null,
  "created": "2018-10-10 15:09:21",
  "updated": "2019-04-04 11:28:39",
  "live": true
}

Changes the product that the subscription is tied to. Past orders are unchanged; items in unsent orders pick up the new product.

Returns 400 when:

product doesn’t exist for the merchant
The subscription isn’t live
The subscription is prepaid, has prepaid orders remaining, and the new product’s price differs from the current product’s

Merchants can ask Ordergroove support to allow prepaid swaps to a lower-priced product. Swaps to a higher-priced product stay blocked while prepaid orders remain.

Authentication

x-api-keystring

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

authorizationstring

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

Path parameters

subscription_public_idstringRequired

Unique subscription ID

Request

This endpoint expects an object.

productstringRequired

Product ID

Response

200

customerstringOptional

merchantstringOptional

productstringOptional

paymentstringOptional

shipping_addressstringOptional

offerstringOptional

subscription_typestringOptional

componentslist of objectsOptional

extra_dataobjectOptional

public_idstringOptional

product_attributeanyOptional

quantityintegerOptionalDefaults to 0

pricestring or nullOptional

frequency_daysintegerOptionalDefaults to 0

reminder_daysintegerOptionalDefaults to 0

everyintegerOptionalDefaults to 0

every_periodintegerOptionalDefaults to 0

start_datestringOptional

cancelledstring or nullOptional

cancel_reasonstring or nullOptional

cancel_reason_codeinteger or nullOptional

iterationanyOptional

sequenceanyOptional

session_idstringOptional

merchant_order_idstringOptional

customer_repinteger or nullOptional

clubanyOptional

createdstringOptional

updatedstringOptional

livebooleanOptionalDefaults to true

Errors

403

Forbidden Error

404

Not Found Error