Update product stock

PATCH

/v1/products/{id}/stock

curl --request PATCH \
  --url https://api.orderfast.com.ar/v1/products/example/stock \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "stock": 25, "min_stock_alarm": 5 }'

• Production
• Testing
• Local

Authorizations

• api-key

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

stock

required

number

Example

25

min_stock_alarm

required

number

Example

5

Example

{
  "stock": 25,
  "min_stock_alarm": 5
}

Responses

200

Successful response

Media typeapplication/json

object

data

required

object

enabled

required

boolean

quantity

required

number

min_stock_alarm

required

number

Examples

Examplesuccess

Successful response

{
  "data": {
    "enabled": true,
    "quantity": 30,
    "min_stock_alarm": 5
  }
}

401

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..."
  }
}

403

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..."
  }
}

404

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 stock not found",
    "request_id": "req_01J..."
  }
}

422

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..."
  }
}

500

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..."
  }
}