OfficeGest
Stocks/Articles/{article}/Complementaries

List article complementary articles

Returns complementary articles associated with this article. Complementary articles are suggested items often sold together or related to the main article (cross-selling suggestions).

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

In: header

Path Parameters

articlestring

Query Parameters

complementary_id?stringDeprecated

Filter by complementary article ID (supports operators: eq, like)

filter[complementary_id][operator]?string

Operators: eq, like. Example: filter[complementary_id][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/complementaries?complementary_id=string&filter%5Bcomplementary_id%5D%5Boperator%5D=string&page=1&limit=50"
{
  "data": [
    {
      "complementary_id": "string",
      "quantity": 0,
      "extra_description": "string",
      "required": true,
      "multiple_quantity": true,
      "complementary_price": 0
    }
  ],
  "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"
  }
}