List products

GET

/v1/products

curl --request GET \
  --url 'https://api.orderfast.com.ar/v1/products?limit=50&offset=0&visible=true&category_id=cat_123&search=burger&sku=BURGER-001' \
  --header 'Authorization: Bearer <token>'

• Production
• Testing
• Local

Authorizations

• api-key

Parameters

Query Parameters

limit

object

Example

50

offset

object

Example

0

visible

boolean

Example

true

category_id

string

Example

cat_123

search

string

Example

burger

sku

string

Example

BURGER-001

Responses

200

Successful paginated response

Media typeapplication/json

object

data

required

Array<object>

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

pagination

required

object

limit

required

number

offset

required

number

total

required

number

Examples

Examplesuccess

Successful paginated 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"
        }
      ]
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 1
  }
}

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

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