GambioInstall

Summary

Retrieve all VPEs (packaging units) from the Gambio API.

Inputs

• authentication (required) — How to authenticate with the Gambio API. Default is Basic Auth (admin email/password). Bearer Token (JWT) is available but works for v3 API only; VPE resource uses v2 API, so Basic Auth is the applicable choice.
• vpeQueryParams — Optional pagination and result-limiting parameters sent as query string to the API. Page is 0-based; Per Page defaults to 50.
• requestOptions — Optional request-level configuration including batching throttling, proxy, SSL certificate bypass, and timeout settings.

Output shape

An array of VPE objects. Each object contains at minimum: id, default boolean flag, and multilingual names (de/en). Example returned structure: [ { id: 1, default: false, names: { de: 'pro Stück', en: 'per piece' } } ]

The underlying API endpoint is GET /api.php/v2/vpe. Authentication is mandatory. The vpeQueryParams.page and vpeQueryParams.perPage parameters control pagination and page size via query strings. requestOptions can enable request batching (with configurable batch size and interval in ms), HTTP proxy usage, SSL certificate bypass (insecure), and request timeout in milliseconds (minimum 1, default 10000).

Examples

Example 1: Fetch the first page of VPEs with 25 results per page using Basic Auth.

authentication: basicAuth; vpeQueryParams: { page: 0, perPage: 25 }; requestOptions: {}