Ordergroove Developer Documentation

{
  "customer": "00026001",
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "product": "70067689",
  "payment": "443ddf72094711e9a5afbc764e1043b0",
  "shipping_address": "394aee16d61611e88b4abc764e1043b0",
  "offer": "a748aa648ac811e8af3bbc764e106cf4",
  "subscription_type": "replenishment",
  "components": [],
  "extra_data": {},
  "public_id": "0ff0f88accc511e8b6c0bc764e106cf4",
  "quantity": 4,
  "frequency_days": 120,
  "reminder_days": 10,
  "every": 4,
  "every_period": 3,
  "start_date": "2018-12-27",
  "cancelled": "2019-04-02 13:54:12",
  "cancel_reason": "4|Overstocked",
  "cancel_reason_code": 4,
  "session_id": "ac4f7938383a11e89ecbbc764e1107f2.896371.1539022086",
  "merchant_order_id": "2906548",
  "created": "2018-10-10 14:45:38",
  "updated": "2019-04-02 13:54:12",
  "live": false
}

Cancels a subscription and any subsequent shipments.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

subscription_idstringRequired

Unique Subscription ID

Request

This endpoint expects an object.

cancel_reasonstringOptional

Pipe-delimited cancel reason code and cancel reason details

Response

200

customerstringOptional

merchantstringOptional

productstringOptional

paymentstringOptional

shipping_addressstringOptional

offerstringOptional

subscription_typestringOptional

componentslist of objectsOptional

extra_dataobjectOptional

public_idstringOptional

product_attributemap from strings to any or nullOptional

quantityintegerOptionalDefaults to 0

pricedouble or nullOptional

frequency_daysintegerOptionalDefaults to 0

reminder_daysintegerOptionalDefaults to 0

everyintegerOptionalDefaults to 0

every_periodintegerOptionalDefaults to 0

start_datestringOptional

cancelledstringOptional

cancel_reasonstringOptional

cancel_reason_codeintegerOptionalDefaults to 0

iterationdouble or nullOptional

sequencedouble or nullOptional

session_idstringOptional

merchant_order_idstringOptional

customer_repmap from strings to any or nullOptional

clubmap from strings to any or nullOptional

createdstringOptional

updatedstringOptional

livebooleanOptionalDefaults to true

Errors

400

Bad Request Error