Ir al contenido

Update product

PATCH
/v1/products/{id}
curl --request PATCH \
--url https://api.orderfast.com.ar/v1/products/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "external_id": "erp-product-1001", "sku": "PIZZA-001", "name": "Pizza muzzarella", "description": "Pizza grande de muzzarella", "price": 12000, "visible": true, "category_ids": [ "cat_123" ], "stock": { "enabled": true, "quantity": 30, "min_stock_alarm": 5 }, "image_url": "https://cdn.orderfast.com.ar/products/pizza.png" }'
id
required
string
Media typeapplication/json
object
external_id
string
Example
erp-product-1001
sku
string
Example
PIZZA-001
name
string
Example
Pizza muzzarella
description
string
Example
Pizza grande de muzzarella
price
number
Example
12000
visible
boolean
Example
true
category_ids
Array<string>
Example
[
"cat_123"
]
stock
object
enabled
required
boolean
Example
true
quantity
required
number
Example
30
min_stock_alarm
required
number
Example
5
Example
{
"enabled": true,
"quantity": 30,
"min_stock_alarm": 5
}
image_url
string
Example
https://cdn.orderfast.com.ar/products/pizza.png
Example
{
"external_id": "erp-product-1001",
"sku": "PIZZA-001",
"name": "Pizza muzzarella",
"description": "Pizza grande de muzzarella",
"price": 12000,
"visible": true,
"category_ids": [
"cat_123"
],
"stock": {
"enabled": true,
"quantity": 30,
"min_stock_alarm": 5
},
"image_url": "https://cdn.orderfast.com.ar/products/pizza.png"
}

Successful response

Media typeapplication/json
object
data
required
object
id
required
string
external_id
string
sku
required
string
name
required
string
description
required
string
price
required
number
visible
required
boolean
image_url
required
string
stock
required
object
enabled
required
boolean
quantity
required
number
min_stock_alarm
required
number
categories
required
Array<object>
object
id
required
string
name
required
string
Examples
Examplesuccess

Successful response

{
"data": {
"id": "prod_9f03",
"sku": "BURGER-001",
"name": "Hamburguesa Simple",
"description": "Medallón, queso y pan",
"price": 8500,
"visible": true,
"image_url": "https://cdn.orderfast.com.ar/products/burger.png",
"stock": {
"enabled": true,
"quantity": 30,
"min_stock_alarm": 5
},
"categories": [
{
"id": "cat_123",
"name": "Hamburguesas"
}
]
}
}

Unauthorized — missing or invalid API key

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error
message
required
string
request_id
required
string
Examples
Exampleunauthorized

Invalid API key

{
"error": {
"code": "unauthorized",
"message": "Missing or invalid API key",
"request_id": "req_01J..."
}
}

Permission denied

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error
message
required
string
request_id
required
string
Examples
Examplepermission_denied

Missing permission

{
"error": {
"code": "permission_denied",
"message": "The API key does not have the required permission",
"request_id": "req_01J..."
}
}

Resource not found

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error
message
required
string
request_id
required
string
Examples
Exampleresource_not_found

Not found

{
"error": {
"code": "resource_not_found",
"message": "Product not found",
"request_id": "req_01J..."
}
}

Validation error

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error
message
required
string
request_id
required
string
Examples
Examplevalidation_error

Invalid body or query

{
"error": {
"code": "validation_error",
"message": "One or more fields failed validation",
"request_id": "req_01J..."
}
}

Internal server error

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error
message
required
string
request_id
required
string
Examples
Exampleinternal_error

Unexpected failure

{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred",
"request_id": "req_01J..."
}
}