Update

PATCH

https://restapi.ordergroove.com/products/:external_product_id/

PATCH

/products/:external_product_id/

curl -X PATCH https://restapi.ordergroove.com/products/external_product_id/ \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "autoship_enabled": true
}'

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

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

merchantstringOptional

groupslist of objectsOptional

namestringOptional

pricestringOptional

image_urlstringOptional

detail_urlstringOptional

external_product_idstringOptional

skustringOptional

autoship_enabledbooleanOptional

premier_enabledintegerOptional

createdstringOptional

last_updatestringOptional

livebooleanOptional

discontinuedbooleanOptional

offer_profilestring or nullOptional

extra_dataanyOptional

incentive_groupanyOptional

product_typestringOptional

autoship_by_defaultbooleanOptional

everyintegerOptional

every_periodintegerOptional

prepaid_eligiblebooleanOptional

Whether the product is eligible for prepaid subscriptions.

Errors

400

Bad Request Error

403

Forbidden Error