For the specified market cart, create a quote.
Field | Type | Notes |
---|
accnt | A valid account number, up to 6 digits in length. | * Optional |
admin | An associative array of arbitrary keys and values. | * Optional |
created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | |
discounts | An array of associative arrays containing | * Optional |
| amount | A floating-point value. | | deferrable | A boolean value (0 or 1). | | discount_uuid | A valid UUID (Universally Unique IDentifier). | | eligibility | An associative array containing the fields: | |
| categories | An array of arbitrary values. | products | An array of arbitrary values. |
|
exclusive | A boolean value (0 or 1). | | item_uuid | A valid UUID (Universally Unique IDentifier). | * Optional | modifiable | A boolean value (0 or 1). | | modified | A boolean value (0 or 1). | | month_end | A non-negative integer value (i.e. 0 and up). | | month_start | A positive integer value (i.e. 1 and up). | | owner | A string of text, containing no newlines or other control characters. | | priority | A positive integer value (i.e. 1 and up). | | repetition | A non-negative integer value (i.e. 0 and up). | | strategy | One of: 'credit', 'percent', 'percent_mrc' | | type | One of: 'account', 'admin', 'bundle', 'coupon', 'offset', 'package', 'reseller' | |
|
expiration | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | |
is_expired | A boolean value (0 or 1). | * Optional |
is_quote | A boolean value (0 or 1). | * Optional |
items | An array of associative arrays containing | * Optional |
| code | Either: a valid market bundle code, beginning with "BNDL-" and the rest beging at least 3 chars long, including at least one letter.; or a valid market package code, beginning with "PKG-" and the rest beging at least 3 chars long, including at least one letter.; or a valid product code, at least 3 chars long, including at least one letter. | cycle | A valid billing cycle (monthly, quarterly, biannually, yearly, or biennially). | details | One of the following: |
| An associative array containing the fields: A market cart item containing all the details of a cart item containing a single product | * Optional |
active | A boolean value (0 or 1). | | base_price | A positive floating-point value representing a price, containing 2 to 5 decimals. | | capabilities | An array of arbitrary values. | * Optional | categories | An array of arbitrary values. | | code | A valid product code, at least 3 chars long, including at least one letter. | | description | A string permitting tabs, carriage returns and newlines | | discountable | A boolean value (0 or 1). | | extra_data | An associative array of arbitrary keys and values. | * Optional | global_discountable | A boolean value (0 or 1). | * Optional | options | An array of associative arrays containing | |
| catalog_price | A positive floating-point value representing a price, containing 2 to 5 decimals. | | catalog_value_price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | | discountable | A boolean value (0 or 1). | * Optional | key | A product option name. | | key_description | A string of text, containing no newlines or other control characters. | | key_display_order | An integer value. | | key_group | A string of text, containing no newlines or other control characters. | | key_group_display_order | A string of text, containing no newlines or other control characters. | | num_units | An integer value. | * Optional | package_to_product_option_visibility | A single word, consisting of only letters and digits. | * Optional | parent_ptok_id | A valid id number (a positive integer). | * Optional | parent_ptov_id | A valid id number (a positive integer). | * Optional | price | A positive floating-point value representing a price, containing 2 to 5 decimals. | | price_total | A positive floating-point value representing a price, containing 2 to 5 decimals. | | ptok_id | A valid id number (a positive integer). | | ptov_id | A valid id number (a positive integer). | | value | A product option value. | | value_comments | A string permitting tabs, carriage returns and newlines | * Optional | value_description | A string of text, containing no newlines or other control characters. | | value_discountable | A boolean value (0 or 1). | * Optional | value_display_order | An integer value. | | value_price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | |
|
package_add_on | A boolean value (0 or 1). | * Optional | package_custom_description | A string permitting tabs, carriage returns and newlines | * Optional | package_custom_title | A string permitting tabs, carriage returns and newlines | * Optional | package_display_order | A positive integer value (i.e. 1 and up). | * Optional | package_show_description | A boolean value (0 or 1). | * Optional | package_to_product_id | A valid id number (a positive integer). | * Optional | price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | | product_id | A valid id number (a positive integer). | | properties | An associative array of arbitrary keys and values. | * Optional | region_id | A positive integer value (i.e. 1 and up). | | related_package_to_product_id | A valid id number (a positive integer). | * Optional | series_description | A string permitting tabs, carriage returns and newlines | * Optional | series_display_order | A positive integer value (i.e. 1 and up). | * Optional | series_entry_cart_category | A string permitting tabs, carriage returns and newlines | * Optional | series_entry_cart_plan | A string permitting tabs, carriage returns and newlines | * Optional | series_entry_cart_series | A string permitting tabs, carriage returns and newlines | * Optional | series_entry_display_order | A positive integer value (i.e. 1 and up). | * Optional | series_entry_featured | A boolean value (0 or 1). | * Optional | subdomain | A single word, consisting of only letters, digits, and underscores. | * Optional | subtitle | A string of text, containing no newlines or other control characters. | * Optional | title | A string of text, containing no newlines or other control characters. | | uuid | A valid UUID (Universally Unique IDentifier). | | valid | A boolean value (0 or 1). | |
|
An associative array containing the fields: A market cart item containing all the details of a cart item containing a market package | * Optional |
active | A boolean value (0 or 1). | | bundle_add_on | A boolean value (0 or 1). | * Optional | bundle_display_order | A positive integer value (i.e. 1 and up). | * Optional | bundle_to_package_id | A valid id number (a positive integer). | * Optional | code | A valid market package code, beginning with "PKG-" and the rest beging at least 3 chars long, including at least one letter. | | products | An array of associative arrays containing | |
| active | A boolean value (0 or 1). | | base_price | A positive floating-point value representing a price, containing 2 to 5 decimals. | | capabilities | An array of arbitrary values. | * Optional | categories | An array of arbitrary values. | | code | A valid product code, at least 3 chars long, including at least one letter. | | description | A string permitting tabs, carriage returns and newlines | | discountable | A boolean value (0 or 1). | | extra_data | An associative array of arbitrary keys and values. | * Optional | global_discountable | A boolean value (0 or 1). | * Optional | options | An array of associative arrays containing | |
| catalog_price | A positive floating-point value representing a price, containing 2 to 5 decimals. | | catalog_value_price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | | discountable | A boolean value (0 or 1). | * Optional | key | A product option name. | | key_description | A string of text, containing no newlines or other control characters. | | key_display_order | An integer value. | | key_group | A string of text, containing no newlines or other control characters. | | key_group_display_order | A string of text, containing no newlines or other control characters. | | num_units | An integer value. | * Optional | package_to_product_option_visibility | A single word, consisting of only letters and digits. | * Optional | parent_ptok_id | A valid id number (a positive integer). | * Optional | parent_ptov_id | A valid id number (a positive integer). | * Optional | price | A positive floating-point value representing a price, containing 2 to 5 decimals. | | price_total | A positive floating-point value representing a price, containing 2 to 5 decimals. | | ptok_id | A valid id number (a positive integer). | | ptov_id | A valid id number (a positive integer). | | value | A product option value. | | value_comments | A string permitting tabs, carriage returns and newlines | * Optional | value_description | A string of text, containing no newlines or other control characters. | | value_discountable | A boolean value (0 or 1). | * Optional | value_display_order | An integer value. | | value_price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | |
|
package_add_on | A boolean value (0 or 1). | * Optional | package_custom_description | A string permitting tabs, carriage returns and newlines | * Optional | package_custom_title | A string permitting tabs, carriage returns and newlines | * Optional | package_display_order | A positive integer value (i.e. 1 and up). | * Optional | package_show_description | A boolean value (0 or 1). | * Optional | package_to_product_id | A valid id number (a positive integer). | * Optional | price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | | product_id | A valid id number (a positive integer). | | properties | An associative array of arbitrary keys and values. | * Optional | region_id | A positive integer value (i.e. 1 and up). | | related_package_to_product_id | A valid id number (a positive integer). | * Optional | series_description | A string permitting tabs, carriage returns and newlines | * Optional | series_display_order | A positive integer value (i.e. 1 and up). | * Optional | series_entry_cart_category | A string permitting tabs, carriage returns and newlines | * Optional | series_entry_cart_plan | A string permitting tabs, carriage returns and newlines | * Optional | series_entry_cart_series | A string permitting tabs, carriage returns and newlines | * Optional | series_entry_display_order | A positive integer value (i.e. 1 and up). | * Optional | series_entry_featured | A boolean value (0 or 1). | * Optional | subdomain | A single word, consisting of only letters, digits, and underscores. | * Optional | subtitle | A string of text, containing no newlines or other control characters. | * Optional | title | A string of text, containing no newlines or other control characters. | | uuid | A valid UUID (Universally Unique IDentifier). | | valid | A boolean value (0 or 1). | |
|
properties | An associative array of arbitrary keys and values. | * Optional | title | A string of text, containing no newlines or other control characters. | | uuid | A valid UUID (Universally Unique IDentifier). | | valid | A boolean value (0 or 1). | | version_id | A valid id number (a positive integer). | |
|
An associative array containing the fields: A market cart item containing all the details of a cart item containing a market bundle | * Optional |
active | A boolean value (0 or 1). | | code | A valid market bundle code, beginning with "BNDL-" and the rest beging at least 3 chars long, including at least one letter. | | packages | An array of associative arrays containing | |
| active | A boolean value (0 or 1). | | bundle_add_on | A boolean value (0 or 1). | * Optional | bundle_display_order | A positive integer value (i.e. 1 and up). | * Optional | bundle_to_package_id | A valid id number (a positive integer). | * Optional | code | A valid market package code, beginning with "PKG-" and the rest beging at least 3 chars long, including at least one letter. | | products | An array of associative arrays containing | |
| active | A boolean value (0 or 1). | | base_price | A positive floating-point value representing a price, containing 2 to 5 decimals. | | capabilities | An array of arbitrary values. | * Optional | categories | An array of arbitrary values. | | code | A valid product code, at least 3 chars long, including at least one letter. | | description | A string permitting tabs, carriage returns and newlines | | discountable | A boolean value (0 or 1). | | extra_data | An associative array of arbitrary keys and values. | * Optional | global_discountable | A boolean value (0 or 1). | * Optional | options | An array of associative arrays containing | |
| catalog_price | A positive floating-point value representing a price, containing 2 to 5 decimals. | | catalog_value_price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | | discountable | A boolean value (0 or 1). | * Optional | key | A product option name. | | key_description | A string of text, containing no newlines or other control characters. | | key_display_order | An integer value. | | key_group | A string of text, containing no newlines or other control characters. | | key_group_display_order | A string of text, containing no newlines or other control characters. | | num_units | An integer value. | * Optional | package_to_product_option_visibility | A single word, consisting of only letters and digits. | * Optional | parent_ptok_id | A valid id number (a positive integer). | * Optional | parent_ptov_id | A valid id number (a positive integer). | * Optional | price | A positive floating-point value representing a price, containing 2 to 5 decimals. | | price_total | A positive floating-point value representing a price, containing 2 to 5 decimals. | | ptok_id | A valid id number (a positive integer). | | ptov_id | A valid id number (a positive integer). | | value | A product option value. | | value_comments | A string permitting tabs, carriage returns and newlines | * Optional | value_description | A string of text, containing no newlines or other control characters. | | value_discountable | A boolean value (0 or 1). | * Optional | value_display_order | An integer value. | | value_price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | |
|
package_add_on | A boolean value (0 or 1). | * Optional | package_custom_description | A string permitting tabs, carriage returns and newlines | * Optional | package_custom_title | A string permitting tabs, carriage returns and newlines | * Optional | package_display_order | A positive integer value (i.e. 1 and up). | * Optional | package_show_description | A boolean value (0 or 1). | * Optional | package_to_product_id | A valid id number (a positive integer). | * Optional | price_time_unit | A single word, consisting of only letters, digits, hyphens, and underscores. | | product_id | A valid id number (a positive integer). | | properties | An associative array of arbitrary keys and values. | * Optional | region_id | A positive integer value (i.e. 1 and up). | | related_package_to_product_id | A valid id number (a positive integer). | * Optional | series_description | A string permitting tabs, carriage returns and newlines | * Optional | series_display_order | A positive integer value (i.e. 1 and up). | * Optional | series_entry_cart_category | A string permitting tabs, carriage returns and newlines | * Optional | series_entry_cart_plan | A string permitting tabs, carriage returns and newlines | * Optional | series_entry_cart_series | A string permitting tabs, carriage returns and newlines | * Optional | series_entry_display_order | A positive integer value (i.e. 1 and up). | * Optional | series_entry_featured | A boolean value (0 or 1). | * Optional | subdomain | A single word, consisting of only letters, digits, and underscores. | * Optional | subtitle | A string of text, containing no newlines or other control characters. | * Optional | title | A string of text, containing no newlines or other control characters. | | uuid | A valid UUID (Universally Unique IDentifier). | | valid | A boolean value (0 or 1). | |
|
properties | An associative array of arbitrary keys and values. | * Optional | title | A string of text, containing no newlines or other control characters. | | uuid | A valid UUID (Universally Unique IDentifier). | | valid | A boolean value (0 or 1). | | version_id | A valid id number (a positive integer). | |
|
properties | An associative array of arbitrary keys and values. | * Optional | title | A string of text, containing no newlines or other control characters. | | uuid | A valid UUID (Universally Unique IDentifier). | | valid | A boolean value (0 or 1). | | version_id | A valid id number (a positive integer). | |
|
|
type | A string of text, containing no newlines or other control characters. | units | A positive integer value (i.e. 1 and up). | uuid | A valid UUID (Universally Unique IDentifier). |
|
metadata | An associative array of arbitrary keys and values. | * Optional |
orderable | A boolean value (0 or 1). | |
share | A valid UUID (Universally Unique IDentifier). | |
status | A single word, consisting of only letters, digits, and underscores. | |
totals | An associative array containing the fields: | * Optional |
| charges | An array of associative arrays containing |
| billing | An array of associative arrays containing |
| cart | An associative array containing the fields: |
| cost | An associative array containing the fields: |
| discountable | A monetary value, such as -$.05, 0.05, or -5.00 | non_discountable | A monetary value, such as -$.05, 0.05, or -5.00 | total | A monetary value, such as -$.05, 0.05, or -5.00 |
|
discounts | An array of associative arrays containing |
| amount | A floating-point value. | amount_off | A monetary value, such as -$.05, 0.05, or -5.00 | discount_uuid | An array of a valid UUID (Universally Unique IDentifier). | ineligible_product_uuids | An array of a valid UUID (Universally Unique IDentifier). | type | One of: 'account', 'admin', 'bundle', 'coupon', 'offset', 'package', 'reseller' |
|
items | A positive integer value (i.e. 1 and up). | price | An associative array containing the fields: |
| discountable | A monetary value, such as -$.05, 0.05, or -5.00 | non_discountable | A monetary value, such as -$.05, 0.05, or -5.00 | total | A monetary value, such as -$.05, 0.05, or -5.00 |
|
|
items | An array of associative arrays containing |
| cost | An associative array containing the fields: |
| discountable | A monetary value, such as -$.05, 0.05, or -5.00 | non_discountable | A monetary value, such as -$.05, 0.05, or -5.00 | products | An array of associative arrays containing |
| base_price_discountable | A monetary value, such as -$.05, 0.05, or -5.00 | base_price_non_discountable | A monetary value, such as -$.05, 0.05, or -5.00 | discountable | A monetary value, such as -$.05, 0.05, or -5.00 | non_discountable | A monetary value, such as -$.05, 0.05, or -5.00 | product_code | A valid product code, at least 3 chars long, including at least one letter. | product_uuid | A valid UUID (Universally Unique IDentifier). | total | A monetary value, such as -$.05, 0.05, or -5.00 |
|
total | A monetary value, such as -$.05, 0.05, or -5.00 |
|
discounts | An array of associative arrays containing |
| amount | A floating-point value. | amount_off | A monetary value, such as -$.05, 0.05, or -5.00 | discount_uuid | A valid UUID (Universally Unique IDentifier). | ineligible_product_uuids | An array of a valid UUID (Universally Unique IDentifier). | type | One of: 'account', 'admin', 'bundle', 'coupon', 'offset', 'package', 'reseller' |
|
item_uuid | A valid UUID (Universally Unique IDentifier). | price | An associative array containing the fields: |
| discountable | A monetary value, such as -$.05, 0.05, or -5.00 | non_discountable | A monetary value, such as -$.05, 0.05, or -5.00 | products | An array of associative arrays containing |
| base_price_discountable | A monetary value, such as -$.05, 0.05, or -5.00 | base_price_non_discountable | A monetary value, such as -$.05, 0.05, or -5.00 | discountable | A monetary value, such as -$.05, 0.05, or -5.00 | non_discountable | A monetary value, such as -$.05, 0.05, or -5.00 | product_code | A valid product code, at least 3 chars long, including at least one letter. | product_uuid | A valid UUID (Universally Unique IDentifier). | total | A monetary value, such as -$.05, 0.05, or -5.00 |
|
total | A monetary value, such as -$.05, 0.05, or -5.00 |
|
|
month_end | A positive integer value (i.e. 1 and up). | month_start | A positive integer value (i.e. 1 and up). | months | A positive integer value (i.e. 1 and up). | occurrence | A positive integer value (i.e. 1 and up). |
|
cycle | A valid billing cycle (monthly, quarterly, biannually, yearly, or biennially). |
|
credits | An array of associative arrays containing |
| amount_off | A monetary value, such as -$.05, 0.05, or -5.00 | | item_uuid | A valid UUID (Universally Unique IDentifier). | * Optional | month_end | A positive integer value (i.e. 1 and up). | | month_start | A positive integer value (i.e. 1 and up). | | months | A positive integer value (i.e. 1 and up). | |
|
summary | An associative array containing the fields: |
| cart | An associative array containing the fields: |
| amount_off_today | A monetary value, such as -$.05, 0.05, or -5.00 | cost | A monetary value, such as -$.05, 0.05, or -5.00 | due_today | A monetary value, such as -$.05, 0.05, or -5.00 | price | A monetary value, such as -$.05, 0.05, or -5.00 |
|
items | An array of associative arrays containing |
| cost | A monetary value, such as -$.05, 0.05, or -5.00 | cycle | A valid billing cycle (monthly, quarterly, biannually, yearly, or biennially). | discounts | An array of associative arrays containing |
| amount | A monetary value, such as -$.05, 0.05, or -5.00 | amount_off_today | A monetary value, such as -$.05, 0.05, or -5.00 | discount_uuid | A valid UUID (Universally Unique IDentifier). | owner | A string of text, containing no newlines or other control characters. | repetitions | A non-negative integer value (i.e. 0 and up). | type | One of: 'account', 'admin', 'bundle', 'coupon', 'offset', 'package', 'reseller' |
|
item_uuid | A valid UUID (Universally Unique IDentifier). | price | A monetary value, such as -$.05, 0.05, or -5.00 |
|
|
timeline | An array of associative arrays containing |
| cost | A monetary value, such as -$.05, 0.05, or -5.00 | cycles | An array of a valid billing cycle (monthly, quarterly, biannually, yearly, or biennially). | month | A positive integer value (i.e. 1 and up). | price | A monetary value, such as -$.05, 0.05, or -5.00 |
|
|
updated | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional |
uuid | A valid UUID (Universally Unique IDentifier). | |
version | A positive integer value (i.e. 1 and up). | |