API - Planyo Web Services - get_cart_items

You are here: Planyo » Help » API » get_cart_items

get_cart_items

Description:

Lists all reservations included in a shopping cart. A maximum of 500 reservations will be listed. For further items use the 'page' parameter.

Input:

shopping_cart_id int required
ID of the shopping cart
detail_level int optional
Sum of one or more of the following integers (ORed value): 1=reservation info (all except for price and custom properties), 2=reservation properties (reservation form items), 4=pricing info and flexible package assignments, 8=custom resource properties, 16=site properties, 32=resource photos. Default value is 1.
page int optional
Zero-based page number. The default is 0. Each page lists max 500 reservations.
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:

results array
Array whose items are named arrays with the following keys: reservation_id, start_time, end_time, creation_time, quantity, user_notes, admin_notes, unit_assignment, custom_color, night_reservation, first_name, last_name, login, user_id, email, phone, phone_country_code, mobile_number, mobile_country_code, address, city, zip, country, resource_id, name (resource name), status (0 = not checked out, 1 = checked out). In case detail_level is set, this can also include: properties (named array), total_price and original_price, resources assigned in a flexible package (flexible_package_assignment_X), photos, cart_total_price and cart_currency, resource_properties, or site_properties.

API playground:

Click here to test this function in the API playground.
Planyo has a new Terms of Service and Privacy Policy, effective May 25, 2018. By using Planyo on or after this date you agree to the new conditions (the only change being GDPR compliance).