GambioInstall

Summary

Update an existing parcel service in the Gambio shop using the v2 API by specifying the parcel service ID and providing updated parcel service data in JSON format.

Inputs

• Authentication — Select the method to authenticate with the Gambio API: Basic Auth using admin email and password (works with v2 and v3 APIs) or Bearer Token (JWT) from Gambio Admin (works with v3 API only). Defaults to Basic Auth.
• Parcel Service ID (required) — The numeric ID of the parcel service to update.
• Parcel Service Data (JSON) (required) — A JSON object representing the parcel service's updated data, including fields such as name, isDefault, and multilingual descriptions. URLs can include {TRACKING_NUMBER} as a placeholder to be replaced in tracking links.

Output shape

a single updated parcel service record returned from the API.

Requires the parcelServiceIdV2 to identify the parcel service to update and the parcelServiceDataV2 JSON defining the updated fields. Uses a PUT request to the /api.php/v2/parcel_services/{parcelServiceId} endpoint. The response contains the updated parcel service data. Authentication can be done via Basic Auth or Bearer Token; however, Bearer Token is valid for v3 API only, so Basic Auth is recommended for this v2 resource.

Examples

Example 1: Update the name and default status of a parcel service

Provide the parcelServiceIdV2 as 5 and the parcelServiceDataV2 JSON with the new name 'FedEx' and isDefault as true. Authenticate using Basic Auth.