Skip to main content
PATCH
/
v1
/
products
/
{entity_id}
Patch Product
curl --request PATCH \
  --url https://clientapi.retailgrid.io/v1/products/{entity_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_name": "<string>",
  "manufacturer": "<string>",
  "product_group": "<string>",
  "brand": "<string>",
  "status": "<string>",
  "product_type": "<string>",
  "catalog_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "image_url": "<string>",
  "product_url": "<string>",
  "product_created_date": "2023-12-25",
  "tax_rate": 123,
  "product_id": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_id": "<string>",
  "product_name": "<string>",
  "manufacturer": "<string>",
  "product_group": "<string>",
  "brand": "<string>",
  "status": "<string>",
  "product_type": "<string>",
  "catalog_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "image_url": "<string>",
  "product_url": "<string>",
  "product_created_date": "2023-12-25",
  "tax_rate": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.retailgrid.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Retailgrid API keys are prefixed with rg_live_. Pass them as Authorization: Bearer <key>.

Path Parameters

​
entity_id
string<uuid>
required

Body

application/json
​
product_name
string | null
​
manufacturer
string | null
​
product_group
string | null
​
brand
string | null
​
status
string | null
​
product_type
string | null
​
catalog_id
string<uuid> | null
​
image_url
string | null
​
product_url
string | null
​
product_created_date
string<date> | null
​
tax_rate
​
product_id
string | null

Response

Successful Response

​
id
string<uuid>
required
​
product_id
string
required
​
product_name
string | null
​
manufacturer
string | null
​
product_group
string | null
​
brand
string | null
​
status
string | null
​
product_type
string | null
​
catalog_id
string<uuid> | null
​
image_url
string | null
​
product_url
string | null
​
product_created_date
string<date> | null
​
tax_rate
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$