API - Planyo Web Services - get_package_contents

You are here: Planyo » Help » API » get_package_contents

get_package_contents

Description:

This function returns detailed information about a package, including package type and the contents (resources included in the package)

Input:

resource_id int required

ID of the resource

method string required

must be set to get_package_contents

language string optional

by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned

api_key string required

your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.

Output:

package_type string

Type of the package: flexible (flexible package), simple (simple package), or none (not a package)

package_contents array

Array with the following keys: resource_id (ID of the included resource), resource_name, quantity_used, quantity_blocked (only used when blocking is set), category (for flexible packages only)

priority int

Returned only for flexible packages. This is the priority of auto-assignment within category. Possible values are: 0=chosen randomly (daily), 2=chosen randomly (each time), 3=sorted alphabetically

customer_chosen_categories string

Only returned for flexible packages. These are comma-separated categories for which the customer can manually choose the resource used.

API playground:

Click here to test this function in the API playground.