OfficeGest
Stocks/Barcode prefixes

List barcode prefixes

Returns a paginated list of configured barcode prefixes (cbarras). Prefixes drive the decode of variable price/quantity barcodes.

GET
/stocks/barcode-prefixes
AuthorizationBearer <token>

In: header

Query Parameters

order?string
sorder?string
Value in"ASC" | "DESC"
sort?string
limit?integer

Items per page. Default 50, maximum 250; a larger value is truncated to 250.

Default50
Range1 <= value <= 250
prefix?stringDeprecated
type?stringDeprecated
Value in"P" | "Q"
page?integer

Page number. Default 1; a value below 1 counts as 1.

Default1
Range1 <= value
filter[prefix][operator]?string

Filter by exact barcode prefix. Operators: eq, neq, gt, gte, lt, lte, like, ct, nlike, sw, ew, in, nin. Example: filter[prefix][eq]=value

filter[type][operator]?string

Filter by prefix type. P=price, Q=quantity. Operators: eq, neq, gt, gte, lt, lte, like, ct, nlike, sw, ew, in, nin. Example: filter[type][eq]=value

Value in"P" | "Q"

Response Body

curl -X GET "https://og-tenant1.test:8003/api/v2/stocks/barcode-prefixes?order=string&sorder=ASC&sort=string&limit=50&prefix=string&type=P&page=1&filter%5Bprefix%5D%5Boperator%5D=string&filter%5Btype%5D%5Boperator%5D=P"
{
  "data": [
    {
      "prefix": "20",
      "barcode_digits": 13,
      "value_digits": 5,
      "decimal_places": 3,
      "type": "P"
    }
  ],
  "meta": {
    "per_page": 50,
    "current_page": 1,
    "has_more": true
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}