Ordergroove Developer Documentation

{
  "autoship_by_default": false,
  "autoship_enabled": true,
  "created": "2025-03-04 09:12:45",
  "detail_url": "https://www.example.com/products/daily-multivitamin",
  "discontinued": false,
  "every": 2,
  "every_period": 2,
  "external_product_id": "MV-060",
  "extra_data": null,
  "groups": [
    {
      "group_type": "eligibility",
      "name": "subscription"
    }
  ],
  "image_url": "https://www.example.com/images/daily-multivitamin.jpg",
  "incentive_group": null,
  "last_update": "2026-10-09 10:20:31",
  "live": true,
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "name": "Daily Multivitamin, 60 count",
  "offer_profile": null,
  "premier_enabled": 0,
  "prepaid_eligible": false,
  "price": "24.99",
  "product_type": "standard",
  "sku": "MV-060"
}

Turns subscription eligibility on or off for a product by setting autoship_enabled, and returns the updated product in the same format as Retrieve. Any other field in the request is ignored.

This endpoint accepts the Application API Scope only. Storefront API Scope signatures are rejected.

Authentication

x-api-keystring

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

Path parameters

external_product_idstringRequired

Request

This endpoint expects an object.

autoship_enabledbooleanOptional

Whether the product is eligible for subscriptions.

Response

200

Errors

400

Bad Request Error

403

Forbidden Error