Gambio icon

Gambio

Interact with Gambio REST API v3

Actions220

Parcel Service (v2) → Search

AI-generated

Summary

Search parcel services using a JSON-based search condition via the Gambio API v2.

Inputs

  • Authentication (required) — Authentication method to use with the Gambio API: Basic Auth (admin email and password) for v2 and v3 API or Bearer Token (JWT) for v3 API only.
  • Search Condition (JSON) (required) — JSON object specifying the search criteria for parcel services. It supports fields like parcel_services.parcel_services_id, parcel_services.name, and parcel_services.default. This JSON is sent as the request body.
  • Request Options — Optional request controls including batching (items per batch and batch interval), ignoring SSL certificate errors, proxy configuration, and request timeout in milliseconds.

Output shape

a JSON response from the Gambio API containing parcel services that match the provided search condition

The operation sends a POST request to '/api.php/v2/parcel_services/search' with the given JSON search condition. The response is directly returned as JSON. Pagination or other filtering must be handled via the provided search condition or additional request options if supported by the API.

Examples

Example 1: Find parcel services with names like 'DHL'

Set Authentication to Basic Auth or Bearer Token, and provide a JSON search condition such as {"search":{"like":{"parcel_services.name":"%DHL%"}}} to retrieve matching parcel services.

Discussion