Skip to main content
PATCH
/
products
/
{product_id}
Update a product/service catalog record
curl --request PATCH \
  --url http://localhost:8000/products/{product_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "main_code": "<string>",
  "aux_code": "<string>",
  "name": "<string>",
  "unit_price": 1,
  "default_discount": 1,
  "tax_code": "<string>",
  "iva_rate_code": "<string>",
  "applies_tourism_iva": false,
  "applies_ice": false,
  "ice_code": "<string>",
  "additional_fields": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "main_code": "<string>",
  "aux_code": "<string>",
  "name": "<string>",
  "unit_price": "<string>",
  "default_discount": "<string>",
  "tax_code": "<string>",
  "iva_rate_code": "<string>",
  "applies_tourism_iva": true,
  "applies_ice": true,
  "ice_code": "<string>",
  "additional_fields": {},
  "is_active": true,
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Headers

authorization
string | null
x-api-key
string | null
x-tenant-id
string | null

Path Parameters

product_id
string<uuid>
required

Cookies

factio_access_token
string | null

Body

application/json

HTTP request body for partial catalog product/service updates.

main_code
string | null
Required string length: 1 - 25
aux_code
string | null
Maximum string length: 25
name
string | null
Required string length: 1 - 300
unit_price
Required range: x >= 0
default_discount
Required range: x >= 0
tax_code
string | null
Required string length: 1 - 10
iva_rate_code
string | null
Required string length: 1 - 10
applies_tourism_iva
boolean
default:false
applies_ice
boolean
default:false
ice_code
string | null
Maximum string length: 10
additional_fields
Additional Fields · object

Response

Successful Response

API/domain response for a product/service catalog record.

id
string<uuid>
required
tenant_id
string<uuid>
required
main_code
string
required
aux_code
string | null
required
name
string
required
unit_price
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
default_discount
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tax_code
string
required
iva_rate_code
string
required
applies_tourism_iva
boolean
required
applies_ice
boolean
required
ice_code
string | null
required
additional_fields
Additional Fields · object
required
is_active
boolean
required
deleted_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required