Ir al contenido
OrderFastOrderFast API

Create category

POST
/v1/categories
curl --request POST \
  --url https://api.orderfast.com.ar/v1/categories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "external_id": "erp-category-10", "name": "Pizzas", "priority": 2, "visible": true, "image_url": "https://cdn.orderfast.com.ar/categories/pizzas.png" }'

Authorizations

Sección titulada «Authorizations»

Request Bodyrequired

Sección titulada «Request Bodyrequired»
Media typeapplication/json
object
external_id
string
Example
erp-category-10
name
required
string
Example
Pizzas
priority
required
number
Example
2
visible
required
boolean
Example
true
image_url
string
Example
https://cdn.orderfast.com.ar/categories/pizzas.png
Example
{
  "external_id": "erp-category-10",
  "name": "Pizzas",
  "priority": 2,
  "visible": true,
  "image_url": "https://cdn.orderfast.com.ar/categories/pizzas.png"
}

Responses

Sección titulada «Responses»

200

Sección titulada «200»

Successful response

Media typeapplication/json
object
data
required
object
id
required
string
external_id
string
name
required
string
priority
required
number
visible
required
boolean
image_url
required
string
Examples
Examplesuccess

Successful response

{
  "data": {
    "id": "cat_123",
    "name": "Pizzas",
    "priority": 2,
    "visible": true,
    "image_url": "https://cdn.orderfast.com.ar/categories/pizzas.png"
  }
}

401

Sección titulada «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

Sección titulada «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

Sección titulada «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

Sección titulada «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..."
  }
}