Skip to main content
PATCH
/
products
/
{id}
Update a product
curl --request PATCH \
  --url https://api.example.com/products/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "commercialName": "Wireless Mouse",
  "fiscalName": "Mouse Sem Fio Wireless USB",
  "suggestedPrice": 149.9,
  "marginPercentage": 30.5,
  "volumesCount": 1,
  "supplierId": "<string>",
  "groupId": "<string>",
  "defaultWarehouseId": "<string>",
  "externalSku": "<string>",
  "supplierProductName": "<string>",
  "sku": "MOUSE-001",
  "type": "SIMPLE",
  "status": "ACTIVE",
  "isVariationTemplate": false,
  "price": 99.9,
  "category": "Electronics",
  "ean": "7890000000000",
  "ncm": "85072000",
  "cfop": "5102",
  "cst": "102",
  "fiscal": {
    "ncm": "<string>",
    "cest": "<string>",
    "origin": "<string>",
    "cfopEntry": "<string>",
    "cfopExit": "<string>",
    "cstIcms": "<string>",
    "cstIpi": "<string>",
    "cstPis": "<string>",
    "cstCofins": "<string>",
    "pIcms": 123,
    "pIpi": 123,
    "pPis": 123,
    "pCofins": 123,
    "cClassTrib": "<string>",
    "cstIbsCbs": "<string>",
    "pIbsUf": 123,
    "pIbsMun": 123,
    "pCbs": 123,
    "isSubjectToSelectiveTax": false,
    "taxRuleNotes": "<string>"
  },
  "components": [
    {
      "componentId": "uuid-v4",
      "quantity": 1,
      "lossPercentage": 0,
      "isMainItem": false,
      "displayInDescription": true,
      "affectsPrice": true
    }
  ],
  "weight": 123,
  "height": 123,
  "width": 123,
  "length": 123,
  "costAvg": 123,
  "costManual": 123,
  "parentProductId": "<string>",
  "variationAttributes": {},
  "variations": [
    {
      "commercialName": "Wireless Mouse",
      "fiscalName": "Mouse Sem Fio Wireless USB",
      "volumesCount": 1,
      "sku": "MOUSE-001",
      "type": "SIMPLE",
      "status": "ACTIVE",
      "isVariationTemplate": false,
      "price": 99.9,
      "suggestedPrice": 149.9,
      "marginPercentage": 30.5,
      "supplierId": "<string>",
      "groupId": "<string>",
      "defaultWarehouseId": "<string>",
      "externalSku": "<string>",
      "supplierProductName": "<string>",
      "category": "Electronics",
      "ean": "7890000000000",
      "ncm": "85072000",
      "cfop": "5102",
      "cst": "102",
      "fiscal": {
        "ncm": "<string>",
        "cest": "<string>",
        "origin": "<string>",
        "cfopEntry": "<string>",
        "cfopExit": "<string>",
        "cstIcms": "<string>",
        "cstIpi": "<string>",
        "cstPis": "<string>",
        "cstCofins": "<string>",
        "pIcms": 123,
        "pIpi": 123,
        "pPis": 123,
        "pCofins": 123,
        "cClassTrib": "<string>",
        "cstIbsCbs": "<string>",
        "pIbsUf": 123,
        "pIbsMun": 123,
        "pCbs": 123,
        "isSubjectToSelectiveTax": false,
        "taxRuleNotes": "<string>"
      },
      "components": [
        {
          "componentId": "uuid-v4",
          "quantity": 1,
          "lossPercentage": 0,
          "isMainItem": false,
          "displayInDescription": true,
          "affectsPrice": true
        }
      ],
      "weight": 123,
      "height": 123,
      "width": 123,
      "length": 123,
      "costAvg": 123,
      "costManual": 123,
      "parentProductId": "<string>",
      "variationAttributes": {},
      "variations": "<array>",
      "id": "<string>",
      "_deleted": false
    }
  ]
}
'
{
  "id": "cffbca85-da89-4b2a-aecf-31422abcb34a",
  "sku": "PROD-123",
  "commercialName": "Cabo de Dados USB-C Atualizado",
  "updatedAt": "2024-02-15T15:00:00.000Z"
}

​
Path

​
id
string
required
ID do produto

​
Body

​
commercialName
string
Se precisar alterar o título.
​
description
string
Se desejar modificar a descrição interna.
​
brand
string
Idem marca.
​
status
string
Ex: Pausar o produto com enum respectivo.

​
Response

{
  "id": "cffbca85-da89-4b2a-aecf-31422abcb34a",
  "sku": "PROD-123",
  "commercialName": "Cabo de Dados USB-C Atualizado",
  "updatedAt": "2024-02-15T15:00:00.000Z"
}

Path Parameters

​
id
string
required

Body

application/json
​
commercialName
string

Commercial Product Name

Example:

"Wireless Mouse"

​
fiscalName
string

Fiscal Product Name (for invoices)

Example:

"Mouse Sem Fio Wireless USB"

​
suggestedPrice
number

Suggested Price (Price Ceiling)

Example:

149.9

​
marginPercentage
number

Margin Percentage

Example:

30.5

​
volumesCount
number
default:1

Number of Volumes

Example:

1

​
supplierId
string

Supplier ID

​
groupId
string

Product Group ID

​
defaultWarehouseId
string

Default Warehouse ID

​
externalSku
string

External SKU (Supplier SKU)

​
supplierProductName
string

Supplier Product Name

​
sku
string

SKU (Stock Keeping Unit)

Example:

"MOUSE-001"

​
type
enum<string>
default:SIMPLE

Product Type

Available options:
SIMPLE,
KIT,
MANUFACTURED
​
status
enum<string>
default:ACTIVE

Product Status

Available options:
ACTIVE,
INACTIVE
​
isVariationTemplate
boolean
default:false

Is Variation Template (Parent)

​
price
number
default:0

Price

Example:

99.9

​
category
string

Category

Example:

"Electronics"

​
ean
string

EAN / GTIN

Example:

"7890000000000"

​
ncm
string

NCM Code

Example:

"85072000"

​
cfop
string

CFOP Code

Example:

"5102"

​
cst
string

CST/CSOSN Code

Example:

"102"

​
fiscal
object

Fiscal Data (Complete)

​
components
object[]

Kit Components (only for KIT/MANUFACTURED)

​
weight
number

Weight (kg)

​
height
number

Height (cm)

​
width
number

Width (cm)

​
length
number

Length (cm)

​
costAvg
number

Average Cost

​
costManual
number

Manual Cost

​
parentProductId
string

Parent Product ID (if variant)

​
variationAttributes
object

Variation Attributes (e.g. { color: "Red" })

​
variations
object[]

Product Variations

Response

The product has been successfully updated.