Get category by external id

GET

/v2/categories/by-external-id/{external_id}

curl --request GET \
  --url https://api.orderfast.com.ar/v2/categories/by-external-id/example \
  --header 'Authorization: Bearer <token>'

• Production
• Testing
• Local

Authorizations

• api-key

Parameters

Path Parameters

external_id

required

string

Responses

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

Example

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

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