Product

Update an existing record

PUT

http://localhost:3000/api/products/{id}

curl -X PUT 'http://localhost:3000/api/products/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "name": "string",
  "description": "string",
  "enabled": true,
  "code": "string",
  "imageUrl": "string",
  "featuredImage": {},
  "variants": "string",
  "productTypeId": "string",
  "productCategoryId": "string",
  "productType": {},
  "productCategory": {},
  "tags": [
    {}
  ],
  "type": {},
  "category": {},
  "optionGroupUpdateInputs": [
    {}
  ],
  "optionGroupCreateInputs": {},
  "optionGroupDeleteInputs": {},
  "optionDeleteInputs": {},
  "translations": {},
  "language": "string"
}'

const body = `{
  "name": "string",
  "description": "string",
  "enabled": true,
  "code": "string",
  "imageUrl": "string",
  "featuredImage": {},
  "variants": "string",
  "productTypeId": "string",
  "productCategoryId": "string",
  "productType": {},
  "productCategory": {},
  "tags": [
    {}
  ],
  "type": {},
  "category": {},
  "optionGroupUpdateInputs": [
    {}
  ],
  "optionGroupCreateInputs": {},
  "optionGroupDeleteInputs": {},
  "optionDeleteInputs": {},
  "translations": {},
  "language": "string"
}`;

const response = await fetch('http://localhost:3000/api/products/string', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "name": "string",
  "description": "string",
  "enabled": true,
  "code": "string",
  "imageUrl": "string",
  "featuredImage": {},
  "variants": "string",
  "productTypeId": "string",
  "productCategoryId": "string",
  "productType": {},
  "productCategory": {},
  "tags": [
    {}
  ],
  "type": {},
  "category": {},
  "optionGroupUpdateInputs": [
    {}
  ],
  "optionGroupCreateInputs": {},
  "optionGroupDeleteInputs": {},
  "optionDeleteInputs": {},
  "translations": {},
  "language": "string"
}'''

response = requests.put(
    'http://localhost:3000/api/products/string',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "name": "string",
  "description": "string",
  "enabled": true,
  "code": "string",
  "imageUrl": "string",
  "featuredImage": {},
  "variants": "string",
  "productTypeId": "string",
  "productCategoryId": "string",
  "productType": {},
  "productCategory": {},
  "tags": [
    {}
  ],
  "type": {},
  "category": {},
  "optionGroupUpdateInputs": [
    {}
  ],
  "optionGroupCreateInputs": {},
  "optionGroupDeleteInputs": {},
  "optionDeleteInputs": {},
  "translations": {},
  "language": "string"
}

Body

application/json

namestring

descriptionstring

enabledboolean

codestring

imageUrlstring

featuredImageobject

variantsstring

productTypeIdstring

productCategoryIdstring

productTypeobject

productCategoryobject

tagsArray<object>

typeobject

categoryobject

optionGroupUpdateInputsArray<object>

optionGroupCreateInputsobject

optionGroupDeleteInputsobject

optionDeleteInputsobject

translationsobject

languagestring

Parameters

idstringrequiredpath

Response

201Created

The record has been successfully edited.

400Bad Request

Invalid input, The response body may contain clues as to what went wrong

401Unauthorized

Unauthorized

403Forbidden

Forbidden

404Not Found

Record not found

Authorization

bearerhttp (bearer) in header

Enter JWT token

Stack Overflow Website Demo