OfficeGest
Stocks/Articles/{article}/Kits

List article kits

Returns the components of this kit (kits de venda). A kit is a predefined combination of articles sold as a single unit. Shows each component line, quantity, unit, pricing, and whether serial numbers or lots are used.

GET
/stocks/articles/{article}/kits
AuthorizationBearer <token>

In: header

Path Parameters

articlestring

Query Parameters

article_id?stringDeprecated

Filter by kit article ID (supports operators: eq, like, sw, ew)

article_b64_id?stringDeprecated

Filter by kit article ID (base64 encoded)

description?stringDeprecated

Filter by kit description (supports operators: eq, like, sw, ew)

quantity?numberDeprecated

Filter by quantity (supports operators: eq, gte, lte)

selling_price?numberDeprecated

Filter by selling price (supports operators: eq, gte, lte)

cost_price?numberDeprecated

Filter by cost price (supports operators: eq, gte, lte)

cost_price_medium?numberDeprecated

Filter by medium cost price (supports operators: eq, gte, lte)

use_serial_numbers?boolean

Filter by serial number usage

use_lots?boolean

Filter by lot usage

filter[article_id][operator]?string

Operators: eq, like, sw, ew. Example: filter[article_id][eq]=value

filter[article_b64_id][operator]?string

Operators: eq. Example: filter[article_b64_id][eq]=value

filter[description][operator]?string

Operators: eq, like, sw, ew. Example: filter[description][eq]=value

filter[quantity][operator]?number

Operators: eq, gte, lte. Example: filter[quantity][eq]=value

filter[selling_price][operator]?number

Operators: eq, gte, lte. Example: filter[selling_price][eq]=value

filter[cost_price][operator]?number

Operators: eq, gte, lte. Example: filter[cost_price][eq]=value

filter[cost_price_medium][operator]?number

Operators: eq, gte, lte. Example: filter[cost_price_medium][eq]=value

filter?object

Advanced filter as JSON object with field => operator => value

Empty Object

page?integer

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

Default1
Range1 <= value
limit?integer

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

Default50
Range1 <= value <= 250

Response Body

curl -X GET "https://og-tenant1.test:8003/api/v2/stocks/articles/string/kits?article_id=string&article_b64_id=string&description=string&quantity=0&selling_price=0&cost_price=0&cost_price_medium=0&use_serial_numbers=true&use_lots=true&filter%5Barticle_id%5D%5Boperator%5D=string&filter%5Barticle_b64_id%5D%5Boperator%5D=string&filter%5Bdescription%5D%5Boperator%5D=string&filter%5Bquantity%5D%5Boperator%5D=0&filter%5Bselling_price%5D%5Boperator%5D=0&filter%5Bcost_price%5D%5Boperator%5D=0&filter%5Bcost_price_medium%5D%5Boperator%5D=0&page=1&limit=50"
{
  "data": [
    {
      "line": 0,
      "article_id": "string",
      "article_b64_id": "string",
      "description": "string",
      "quantity": 0,
      "unit": "string",
      "selling_price": 0,
      "cost_price": 0,
      "cost_price_medium": 0,
      "use_serial_numbers": true,
      "use_lots": true
    }
  ],
  "meta": {
    "per_page": 50,
    "current_page": 1,
    "has_more": true,
    "total": 120,
    "last_page": 3,
    "from": 1,
    "to": 50
  }
}
{
  "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"
  }
}