> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.ordergroove.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.ordergroove.com/_mcp/server.

# Update

PATCH https://restapi.ordergroove.com/products/{external_product_id}/
Content-Type: application/json

Turns subscription eligibility on or off for a product by setting `autoship_enabled`, and returns the updated product in the same format as [Retrieve](/reference/rest-rpc-api/products/retrieve). Any other field in the request is ignored.

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

Reference: https://developer.ordergroove.com/reference/rest-rpc-api/products/update

## Authentication

- `x-api-key` header (required) — Application API Scope — server-to-server, sent in the `x-api-key` header. See [Authentication](/api-reference/authentication).

## Request

### Path parameters

- `external_product_id` (string, required)

### Body (application/json)

This endpoint expects an object.

- `autoship_enabled` (boolean, optional) — Whether the product is eligible for subscriptions.

## Response

### 200

200

## Errors

### 400 Bad Request Error

400

- `[field_name]` (string, optional)

### 403 Forbidden Error

403

- `detail` (string, optional)

## Examples

### Result

**Response**

```json
{
  "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"
}
```

**SDK Code**

```python Result
import requests

url = "https://restapi.ordergroove.com/products/external_product_id/"

headers = {"x-api-key": "<apiKey>"}

response = requests.patch(url, headers=headers)

print(response.json())
```

```javascript Result
const url = 'https://restapi.ordergroove.com/products/external_product_id/';
const options = {method: 'PATCH', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Result
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://restapi.ordergroove.com/products/external_product_id/"

	req, _ := http.NewRequest("PATCH", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Result
require 'uri'
require 'net/http'

url = URI("https://restapi.ordergroove.com/products/external_product_id/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Result
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://restapi.ordergroove.com/products/external_product_id/")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Result
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://restapi.ordergroove.com/products/external_product_id/', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Result
using RestSharp;

var client = new RestClient("https://restapi.ordergroove.com/products/external_product_id/");
var request = new RestRequest(Method.PATCH);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Result
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://restapi.ordergroove.com/products/external_product_id/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Request Example

**Request**

```json
{
  "autoship_enabled": true
}
```

**Response**

```json
{
  "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"
}
```

**SDK Code**

```python Request Example
import requests

url = "https://restapi.ordergroove.com/products/external_product_id/"

payload = { "autoship_enabled": True }
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript Request Example
const url = 'https://restapi.ordergroove.com/products/external_product_id/';
const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"autoship_enabled":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Request Example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://restapi.ordergroove.com/products/external_product_id/"

	payload := strings.NewReader("{\n  \"autoship_enabled\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Request Example
require 'uri'
require 'net/http'

url = URI("https://restapi.ordergroove.com/products/external_product_id/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"autoship_enabled\": true\n}"

response = http.request(request)
puts response.read_body
```

```java Request Example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://restapi.ordergroove.com/products/external_product_id/")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"autoship_enabled\": true\n}")
  .asString();
```

```php Request Example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://restapi.ordergroove.com/products/external_product_id/', [
  'body' => '{
  "autoship_enabled": true
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Request Example
using RestSharp;

var client = new RestClient("https://restapi.ordergroove.com/products/external_product_id/");
var request = new RestRequest(Method.PATCH);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"autoship_enabled\": true\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Request Example
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["autoship_enabled": true] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://restapi.ordergroove.com/products/external_product_id/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```